MAN page from Fedora 21 libfshfs-devel-20170626-1.fc21.i686.rpm

libfshfs

Section: C Library Functions (3)
Index
BSD mandoc
libfshfs

NAME

libfshfs.h - Library to support the Hierarchical File System (HFS) format

LIBRARY

Lb libfshfs

SYNOPSIS

In libfshfs.h

Support functionsFt const char *Fn libfshfs_get_version voidFt intFn libfshfs_get_access_flags_read voidFt intFn libfshfs_get_codepage int *codepage, libfshfs_error_t **errorFt intFn libfshfs_set_codepage int codepage, libfshfs_error_t **errorFt intFn libfshfs_check_volume_signature const char *filename, libfshfs_error_t **error

Available when compiled with wide character string support:Ft intFn libfshfs_check_volume_signature_wide const wchar_t *filename, libfshfs_error_t **error

Available when compiled with libbfio support:Ft intFn libfshfs_check_volume_signature_file_io_handle libbfio_handle_t *file_io_handle, libfshfs_error_t **error

Notify functionsFt voidFn libfshfs_notify_set_verbose int verboseFt intFn libfshfs_notify_set_stream FILE *stream, libfshfs_error_t **errorFt intFn libfshfs_notify_stream_open const char *filename, libfshfs_error_t **errorFt intFn libfshfs_notify_stream_close libfshfs_error_t **error

Error functionsFt voidFn libfshfs_error_free libfshfs_error_t **errorFt intFn libfshfs_error_fprint libfshfs_error_t *error, FILE *streamFt intFn libfshfs_error_sprint libfshfs_error_t *error, char *string, size_t sizeFt intFn libfshfs_error_backtrace_fprint libfshfs_error_t *error, FILE *streamFt intFn libfshfs_error_backtrace_sprint libfshfs_error_t *error, char *string, size_t size

Volume functionsFt intFn libfshfs_volume_initialize libfshfs_volume_t **volume, libfshfs_error_t **errorFt intFn libfshfs_volume_free libfshfs_volume_t **volume, libfshfs_error_t **errorFt intFn libfshfs_volume_signal_abort libfshfs_volume_t *volume, libfshfs_error_t **errorFt intFn libfshfs_volume_open libfshfs_volume_t *volume, const char *filename, int access_flags, libfshfs_error_t **errorFt intFn libfshfs_volume_close libfshfs_volume_t *volume, libfshfs_error_t **errorFt intFn libfshfs_volume_get_utf8_label_size libfshfs_volume_t *volume, size_t *utf8_string_size, libfshfs_error_t **errorFt intFn libfshfs_volume_get_utf8_label libfshfs_volume_t *volume, uint8_t *utf8_string, size_t utf8_string_size, libfshfs_error_t **errorFt intFn libfshfs_volume_get_utf16_label_size libfshfs_volume_t *volume, size_t *utf16_string_size, libfshfs_error_t **errorFt intFn libfshfs_volume_get_utf16_label libfshfs_volume_t *volume, uint16_t *utf16_string, size_t utf16_string_size, libfshfs_error_t **error

Available when compiled with wide character string support:Ft intFn libfshfs_volume_open_wide libfshfs_volume_t *volume, const wchar_t *filename, int access_flags, libfshfs_error_t **error

Available when compiled with libbfio support:Ft intFn libfshfs_volume_open_file_io_handle libfshfs_volume_t *volume, libbfio_handle_t *file_io_handle, int access_flags, libfshfs_error_t **error

DESCRIPTION

TheFn libfshfs_get_versionfunction 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 "libfshfs.h".

ENVIRONMENT

None

FILES

None

NOTES

libfshfs allows to be compiled with wide character support (wchar_t).

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

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

BUGS

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

AUTHOR

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

COPYRIGHT

This is free software; see the source for copying conditions.There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

This document was created byman2html,using the manual pages.