NAME¶

libcerror.h — Library to support cross-platform C error functions

SYNOPSIS¶

#include <libcerror.h>

Support functions
const char *
libcerror_get_version(void);

Error functions
void
libcerror_error_free(libcerror_error_t **error);

void
libcerror_error_set(libcerror_error_t **error, int error_domain, int error_code, const char *format_string, ...);

int
libcerror_error_matches(libcerror_error_t *error, int error_domain, int error_code);

int
libcerror_error_fprint(libcerror_error_t *error, FILE *stream);

int
libcerror_error_sprint(libcerror_error_t *error, char *string, size_t size);

int
libcerror_error_backtrace_fprint(libcerror_error_t *error, FILE *stream);

int
libcerror_error_backtrace_sprint(libcerror_error_t *error, char *string, size_t size);

System error functions
void
libcerror_system_set_error(libcerror_error_t **error, int error_domain, int error_code, uint32_t system_error_code, const char *format_string, ...);

DESCRIPTION¶

The libcerror_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 "libcerror.h".

ENVIRONMENT¶

None

FILES¶

None

BUGS¶

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

AUTHOR¶

These man pages are generated from "libcerror.h".

COPYRIGHT¶

Copyright (C) 2008-2024, 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 libcerror.h include file