libvsgpt.h — Library to access the GUID Partition Table (GPT) volume system format

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

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

       Copyright (C) 2019-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.

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

       None

       None

       libvsgpt.h — Library to access the GUID Partition Table (GPT) volume system format

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

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

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

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

       the libvsgpt.h include file

libvsgpt                                        January 21, 2021                                     libvsgpt(3)

#include<libvsgpt.h>

       Support functions

       constchar*libvsgpt_get_version(void);

       intlibvsgpt_get_access_flags_read(void);

       intlibvsgpt_get_access_flags_read_write(void);

       intlibvsgpt_get_access_flags_write(void);

       intlibvsgpt_get_codepage(int*codepage, libvsgpt_error_t**error);

       intlibvsgpt_set_codepage(intcodepage, libvsgpt_error_t**error);

       intlibvsgpt_check_volume_signature(constchar*filename, libvsgpt_error_t**error);

       Available when compiled with wide character string support:

       intlibvsgpt_check_volume_signature_wide(constwchar_t*filename, libvsgpt_error_t**error);

       Available when compiled with libbfio support:

       intlibvsgpt_check_volume_signature_file_io_handle(libbfio_handle_t*file_io_handle,
           libvsgpt_error_t**error);

       Notify functions

       voidlibvsgpt_notify_set_verbose(intverbose);

       intlibvsgpt_notify_set_stream(FILE*stream, libvsgpt_error_t**error);

       intlibvsgpt_notify_stream_open(constchar*filename, libvsgpt_error_t**error);

       intlibvsgpt_notify_stream_close(libvsgpt_error_t**error);

       Error functions

       voidlibvsgpt_error_free(libvsgpt_error_t**error);

       intlibvsgpt_error_fprint(libvsgpt_error_t*error, FILE*stream);

       intlibvsgpt_error_sprint(libvsgpt_error_t*error, char*string, size_tsize);

       intlibvsgpt_error_backtrace_fprint(libvsgpt_error_t*error, FILE*stream);

       intlibvsgpt_error_backtrace_sprint(libvsgpt_error_t*error, char*string, size_tsize);

       Volume functions

       intlibvsgpt_volume_initialize(libvsgpt_volume_t**volume, libvsgpt_error_t**error);

       intlibvsgpt_volume_free(libvsgpt_volume_t**volume, libvsgpt_error_t**error);

       intlibvsgpt_volume_signal_abort(libvsgpt_volume_t*volume, libvsgpt_error_t**error);

       intlibvsgpt_volume_open(libvsgpt_volume_t*volume,    constchar*filename,    intaccess_flags,
           libvsgpt_error_t**error);

       intlibvsgpt_volume_close(libvsgpt_volume_t*volume, libvsgpt_error_t**error);

       intlibvsgpt_volume_get_bytes_per_sector(libvsgpt_volume_t*volume,      uint32_t*bytes_per_sector,
           libvsgpt_error_t**error);

       intlibvsgpt_volume_get_disk_identifier(libvsgpt_volume_t*volume, uint8_t*guid_data, size_tguid_data_size,
           libvsgpt_error_t**error);

       intlibvsgpt_volume_get_number_of_partitions(libvsgpt_volume_t*volume,     int*number_of_partitions,
           libvsgpt_error_t**error);

       intlibvsgpt_volume_get_partition_by_index(libvsgpt_volume_t*volume,       intpartition_index,
           libvsgpt_partition_t**partition, libvsgpt_error_t**error);

       intlibvsgpt_volume_has_partition_with_identifier(libvsgpt_volume_t*volume,     uint32_tentry_index,
           libvsgpt_error_t**error);

       intlibvsgpt_volume_get_partition_by_identifier(libvsgpt_volume_t*volume,     uint32_tentry_index,
           libvsgpt_partition_t**partition, libvsgpt_error_t**error);

       Available when compiled with wide character string support:

       intlibvsgpt_volume_open_wide(libvsgpt_volume_t*volume,  constwchar_t*filename,   intaccess_flags,
           libvsgpt_error_t**error);

       Available when compiled with libbfio support:

       intlibvsgpt_volume_open_file_io_handle(libvsgpt_volume_t*volume,    libbfio_handle_t*file_io_handle,
           intaccess_flags, libvsgpt_error_t**error);

       Partition functions

       intlibvsgpt_partition_free(libvsgpt_partition_t**partition, libvsgpt_error_t**error);

       intlibvsgpt_partition_get_entry_index(libvsgpt_partition_t*partition,      uint32_t*entry_index,
           libvsgpt_error_t**error);

       intlibvsgpt_partition_get_identifier(libvsgpt_partition_t*partition,       uint8_t*guid_data,
           size_tguid_data_size, libvsgpt_error_t**error);

       intlibvsgpt_partition_get_type_identifier(libvsgpt_partition_t*partition,      uint8_t*guid_data,
           size_tguid_data_size, libvsgpt_error_t**error);

       intlibvsgpt_partition_get_type(libvsgpt_partition_t*partition, uint8_t*type, libvsgpt_error_t**error);

       intlibvsgpt_partition_get_volume_offset(libvsgpt_partition_t*partition,     off64_t*volume_offset,
           libvsgpt_error_t**error);

       ssize_tlibvsgpt_partition_read_buffer(libvsgpt_partition_t*partition,  void*buffer,   size_tbuffer_size,
           libvsgpt_error_t**error);

       ssize_tlibvsgpt_partition_read_buffer_at_offset(libvsgpt_partition_t*partition,       void*buffer,
           size_tbuffer_size, off64_toffset, libvsgpt_error_t**error);

       off64_tlibvsgpt_partition_seek_offset(libvsgpt_partition_t*partition,    off64_toffset,    intwhence,
           libvsgpt_error_t**error);

       intlibvsgpt_partition_get_offset(libvsgpt_partition_t*partition,          off64_t*offset,
           libvsgpt_error_t**error);

       intlibvsgpt_partition_get_size(libvsgpt_partition_t*partition, size64_t*size, libvsgpt_error_t**error);