libcsystem(3)

NAME
libcsystem.h - Library to support cross-platform C system functions

LIBRARY
libcsystem

SYNOPSIS
#include <libcsystem.h>

Support functions
const char *
libcsystem_get_version(void);
int
libcsystem_file_exists(const char *filename, libcsystem_error_t **error);

Available when compiled with wide character string support:
int
libcsystem_file_exists_wide(const wchar_t *filename, libcsystem_error_t **error);

Error functions
void
libcsystem_error_free(libcsystem_error_t **error);
int
libcsystem_error_fprint(libcsystem_error_t *error, FILE *stream);
int
libcsystem_error_sprint(libcsystem_error_t *error, char *string, size_t size);
int
libcsystem_error_backtrace_fprint(libcsystem_error_t *error, FILE *stream);
int
libcsystem_error_backtrace_sprint(libcsystem_error_t *error, char *string, size_t size);

Support functions
const char *
libcsystem_get_version(void);
int
libcsystem_file_exists(const char *filename, libcsystem_error_t **error);

Available when compiled with wide character string support:
int
libcsystem_file_exists_wide(const wchar_t *filename, libcsystem_error_t **error);

File IO functions

Getopt functions
int
libcsystem_getopt(int argument_count, char * const argument_values[], const char *options_string);

Glob functions
int
libcsystem_glob_initialize(libcsystem_glob_t **glob, libcsystem_error_t **error);
int
libcsystem_glob_free(libcsystem_glob_t **glob, libcsystem_error_t **error);
int
libcsystem_glob_resolve(libcsystem_glob_t *glob, libcstring_system_character_t * const patterns[], int number_of_patterns, libcsystem_error_t **error);
int
libcsystem_glob_get_results(libcsystem_glob_t *glob, int *number_of_results, libcstring_system_character_t ***results, libcsystem_error_t **error);

Internationalization (i18n) functions

Signal functions
int
libcsystem_signal_attach(void (*signal_handler)( libcsystem_signal_t ), libcsystem_error_t **error);
int
libcsystem_signal_detach(libcsystem_error_t **error);

DESCRIPTION
The libcsystem_get_version() function is used to retrieve the library version.

RETURN VALUES
Most of the functions return NULL or -1 on error, dependent on the return type. For the actual return values see "libcsystem.h".

ENVIRONMENT
None

FILES
None libcsystem allows to be compiled with wide character support (wchar_t). To compile libcsystem with wide character support use: ./configure --enable-wide-character-type=yes or define: _UNICODE or UNICODE during compilation. LIBCSYSTEM_WIDE_CHARACTER_TYPE in libcsystem/features.h can be used to determine if libcsystem was compiled with wide character support.

BUGS
Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libcsystem/issues

AUTHOR
These man pages are generated from "libcsystem.h".

COPYRIGHT
Copyright (C) 2008-2015, Joachim Metz <joachim.metz@gmail.com>. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

SEE ALSO
the libcsystem.h include file