libgzipf(3)

NAME
libgzipf.h - Library to access the GZIP file format

SYNOPSIS
#include <libgzipf.h>

Support functions
const char *
libgzipf_get_version(void);
int
libgzipf_get_access_flags_read(void);
int
libgzipf_get_codepage(int *codepage, libgzipf_error_t **error);
int
libgzipf_set_codepage(int codepage, libgzipf_error_t **error);
int
libgzipf_check_file_signature(const char *filename, libgzipf_error_t **error);

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

Available when compiled with libbfio support:
int
libgzipf_check_file_signature_file_io_handle(libbfio_handle_t *file_io_handle, libgzipf_error_t **error);

Notify functions
void
libgzipf_notify_set_verbose(int verbose);
int
libgzipf_notify_set_stream(FILE *stream, libgzipf_error_t **error);
int
libgzipf_notify_stream_open(const char *filename, libgzipf_error_t **error);
int
libgzipf_notify_stream_close(libgzipf_error_t **error);

Error functions
void
libgzipf_error_free(libgzipf_error_t **error);
int
libgzipf_error_fprint(libgzipf_error_t *error, FILE *stream);
int
libgzipf_error_sprint(libgzipf_error_t *error, char *string, size_t size);
int
libgzipf_error_backtrace_fprint(libgzipf_error_t *error, FILE *stream);
int
libgzipf_error_backtrace_sprint(libgzipf_error_t *error, char *string, size_t size);

File functions
int
libgzipf_file_initialize(libgzipf_file_t **file, libgzipf_error_t **error);
int
libgzipf_file_free(libgzipf_file_t **file, libgzipf_error_t **error);
int
libgzipf_file_signal_abort(libgzipf_file_t *file, libgzipf_error_t **error);
int
libgzipf_file_open(libgzipf_file_t *file, const char *filename, int access_flags, libgzipf_error_t **error);
int
libgzipf_file_close(libgzipf_file_t *file, libgzipf_error_t **error);
ssize_t
libgzipf_file_read_buffer(libgzipf_file_t *file, void *buffer, size_t buffer_size, libgzipf_error_t **error);
ssize_t
libgzipf_file_read_buffer_at_offset(libgzipf_file_t *file, void *buffer, size_t buffer_size, off64_t offset, libgzipf_error_t **error);
off64_t
libgzipf_file_seek_offset(libgzipf_file_t *file, off64_t offset, int whence, libgzipf_error_t **error);
int
libgzipf_file_get_offset(libgzipf_file_t *file, off64_t *offset, libgzipf_error_t **error);
int
libgzipf_file_is_corrupted(libgzipf_file_t *file, libgzipf_error_t **error);
int
libgzipf_file_get_uncompressed_data_size(libgzipf_file_t *file, size64_t *uncompressed_data_size, libgzipf_error_t **error);
int
libgzipf_file_get_number_of_members(libgzipf_file_t *file, int *number_of_members, libgzipf_error_t **error);
int
libgzipf_file_get_member_by_index(libgzipf_file_t *file, int member_index, libgzipf_member_t **member, libgzipf_error_t **error);

Available when compiled with wide character string support:
int
libgzipf_file_open_wide(libgzipf_file_t *file, const wchar_t *filename, int access_flags, libgzipf_error_t **error);

Available when compiled with libbfio support:
int
libgzipf_file_open_file_io_handle(libgzipf_file_t *file, libbfio_handle_t *file_io_handle, int access_flags, libgzipf_error_t **error);

Member functions
int
libgzipf_member_free(libgzipf_member_t **member, libgzipf_error_t **error);
int
libgzipf_member_get_modification_time(libgzipf_member_t *member, uint32_t *posix_time, libgzipf_error_t **error);
int
libgzipf_member_get_utf8_name_size(libgzipf_member_t *member, size_t *utf8_string_size, libgzipf_error_t **error);
int
libgzipf_member_get_utf8_name(libgzipf_member_t *member, uint8_t *utf8_string, size_t utf8_string_size, libgzipf_error_t **error);
int
libgzipf_member_get_utf16_name_size(libgzipf_member_t *member, size_t *utf16_string_size, libgzipf_error_t **error);
int
libgzipf_member_get_utf16_name(libgzipf_member_t *member, uint16_t *utf16_string, size_t utf16_string_size, libgzipf_error_t **error);
int
libgzipf_member_get_utf8_comments_size(libgzipf_member_t *member, size_t *utf8_string_size, libgzipf_error_t **error);
int
libgzipf_member_get_utf8_comments(libgzipf_member_t *member, uint8_t *utf8_string, size_t utf8_string_size, libgzipf_error_t **error);
int
libgzipf_member_get_utf16_comments_size(libgzipf_member_t *member, size_t *utf16_string_size, libgzipf_error_t **error);
int
libgzipf_member_get_utf16_comments(libgzipf_member_t *member, uint16_t *utf16_string, size_t utf16_string_size, libgzipf_error_t **error);
int
libgzipf_member_get_operating_system(libgzipf_member_t *member, uint8_t *operating_system, libgzipf_error_t **error);

DESCRIPTION
The libgzipf_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 "libgzipf.h".

ENVIRONMENT
None

FILES
None

NOTES
libgzipf can be compiled with wide character support (wchar_t).

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

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

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

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

COPYRIGHT
Copyright (C) 2019-2022, 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 libgzipf.h include file