NAME¶

libcdirectory.h — Library to support cross-platform C directory functions

SYNOPSIS¶

#include <libcdirectory.h>

Support functions
const char *
libcdirectory_get_version(void);

int
libcdirectory_get_codepage(int *codepage, libcdirectory_error_t **error);

int
libcdirectory_set_codepage(int codepage, libcdirectory_error_t **error);

Error functions
void
libcdirectory_error_free(libcdirectory_error_t **error);

int
libcdirectory_error_fprint(libcdirectory_error_t *error, FILE *stream);

int
libcdirectory_error_sprint(libcdirectory_error_t *error, char *string, size_t size);

int
libcdirectory_error_backtrace_fprint(libcdirectory_error_t *error, FILE *stream);

int
libcdirectory_error_backtrace_sprint(libcdirectory_error_t *error, char *string, size_t size);

Directory functions
int
libcdirectory_directory_initialize(libcdirectory_directory_t **directory, libcdirectory_error_t **error);

int
libcdirectory_directory_free(libcdirectory_directory_t **directory, libcdirectory_error_t **error);

int
libcdirectory_directory_open(libcdirectory_directory_t *directory, const char *directory_name, libcdirectory_error_t **error);

int
libcdirectory_directory_close(libcdirectory_directory_t *directory, libcdirectory_error_t **error);

int
libcdirectory_directory_read_entry(libcdirectory_directory_t *directory, libcdirectory_directory_entry_t *directory_entry, libcdirectory_error_t **error);

int
libcdirectory_directory_has_entry(libcdirectory_directory_t *directory, libcdirectory_directory_entry_t *directory_entry, const char *entry_name, size_t entry_name_length, uint8_t entry_type, uint8_t compare_flags, libcdirectory_error_t **error);

Available when compiled with wide character string support:
int
libcdirectory_directory_open_wide(libcdirectory_directory_t *directory, const wchar_t *directory_name, libcdirectory_error_t **error);

int
libcdirectory_directory_has_entry_wide(libcdirectory_directory_t *directory, libcdirectory_directory_entry_t *directory_entry, const wchar_t *entry_name, size_t entry_name_length, uint8_t entry_type, uint8_t compare_flags, libcdirectory_error_t **error);

Directory entry functions
int
libcdirectory_directory_entry_initialize(libcdirectory_directory_entry_t **directory_entry, libcdirectory_error_t **error);

int
libcdirectory_directory_entry_free(libcdirectory_directory_entry_t **directory_entry, libcdirectory_error_t **error);

int
libcdirectory_directory_entry_get_type(libcdirectory_directory_entry_t *directory_entry, uint8_t *type, libcdirectory_error_t **error);

int
libcdirectory_directory_entry_get_name(libcdirectory_directory_entry_t *directory_entry, char **name, libcdirectory_error_t **error);

Available when compiled with wide character string support:
int
libcdirectory_directory_entry_get_name_wide(libcdirectory_directory_entry_t *directory_entry, wchar_t **name, libcdirectory_error_t **error);

DESCRIPTION¶

The libcdirectory_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 "libcdirectory.h".

ENVIRONMENT¶

None

FILES¶

None

NOTES¶

libcdirectory can be compiled with wide character support (wchar_t).

To compile libcdirectory with wide character support use: ./configure --enable-wide-character-type=yes
or define: _UNICODE
or UNICODE
during compilation.

LIBCDIRECTORY_WIDE_CHARACTER_TYPE
in libcdirectory/features.h can be used to determine if libcdirectory was compiled with wide character support.

BUGS¶

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

AUTHOR¶

These man pages are generated from "libcdirectory.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 libcdirectory.h include file