FreeBSD Manual Pages
libvsapm(3) Library Functions Manual libvsapm(3) NAME libvsapm.h -- Library to access the Apple Partition Map (APM) volume system format SYNOPSIS #include <libvsapm.h> Support functions const char * libvsapm_get_version(void); int libvsapm_get_access_flags_read(void); int libvsapm_get_access_flags_read_write(void); int libvsapm_get_access_flags_write(void); int libvsapm_get_codepage(int *codepage, libvsapm_error_t **error); int libvsapm_set_codepage(int codepage, libvsapm_error_t **error); int libvsapm_check_volume_signature(const char *filename, libvsapm_error_t **error); Available when compiled with wide character string support: int libvsapm_check_volume_signature_wide(const wchar_t *filename, libvsapm_error_t **error); Available when compiled with libbfio support: int libvsapm_check_volume_signature_file_io_handle(libbfio_h*afnidllee__ito_handle, libvsapm_error_t **error); Notify functions void libvsapm_notify_set_verbose(int verbose); int libvsapm_notify_set_stream(FILE *stream, libvsapm_error_t **error); int libvsapm_notify_stream_open(const char *filename, libvsapm_error_t **error); int libvsapm_notify_stream_close(libvsapm_error_t **error); Error functions void libvsapm_error_free(libvsapm_error_t **error); int libvsapm_error_fprint(libvsapm_error_t *error, FILE *stream); int libvsapm_error_sprint(libvsapm_error_t *error, char *string, size_t size); int libvsapm_error_backtrace_fprint(libvsapm_error_t *error, FILE *stream); int libvsapm_error_backtrace_sprint(libvsapm_error_t *error, char *string, size_t size); Volume functions int libvsapm_volume_initialize(libvsapm_volume_t **volume, libvsapm_error_t **error); int libvsapm_volume_free(libvsapm_volume_t **volume, libvsapm_error_t **error); int libvsapm_volume_signal_abort(libvsapm_volume_t *volume, libvsapm_error_t **error); int libvsapm_volume_open(libvsapm_volume_t *volume, const char *filename, int access_flags, libvsapm_error_t **error); int libvsapm_volume_close(libvsapm_volume_t *volume, libvsapm_error_t **error); int libvsapm_volume_get_bytes_per_sector(libvsapm_volume_t *volume, uint32_t *bytes_per_sector, libvsapm_error_t **error); int libvsapm_volume_set_bytes_per_sector(libvsapm_volume_t *volume, uint32_t bytes_per_sector, libvsapm_error_t **error); int libvsapm_volume_get_number_of_partitions(libvsapm_volume_t *volume, int *number_of_partitions, libvsapm_error_t **error); int libvsapm_volume_get_partition_by_index(libvsapm_volume_t *volume, int partition_index, libvsapm_partition_t **partition, libvsapm_error_t **error); Available when compiled with wide character string support: int libvsapm_volume_open_wide(libvsapm_volume_t *volume, const wchar_t *filename, int access_flags, libvsapm_error_t **error); Available when compiled with libbfio support: int libvsapm_volume_open_file_io_handle(libvsapm_volume_t *volume, libbfio_handle_t *file_io_handle, int access_flags, libvsapm_error_t **error); Partition functions int libvsapm_partition_free(libvsapm_partition_t **partition, libvsapm_error_t **error); int libvsapm_partition_get_name_string(libvsapm_partition_t *partition, char *string, size_t string_size, libvsapm_error_t **error); int libvsapm_partition_get_type_string(libvsapm_partition_t *partition, char *string, size_t string_size, libvsapm_error_t **error); int libvsapm_partition_get_status_flags(libvsapm_partition_t *partition, uint32_t *status_flags, libvsapm_error_t **error); int libvsapm_partition_get_volume_offset(libvsapm_partition_t *partition, off64_t *volume_offset, libvsapm_error_t **error); ssize_t libvsapm_partition_read_buffer(libvsapm_partition_t *partition, void *buffer, size_t buffer_size, libvsapm_error_t **error); ssize_t libvsapm_partition_read_buffer_at_offset(libvsapm_partition_t*partition, void *buffer, size_t buffer_size, off64_t offset, libvsapm_error_t **error); off64_t libvsapm_partition_seek_offset(libvsapm_partition_t *partition, off64_t offset, int whence, libvsapm_error_t **error); int libvsapm_partition_get_offset(libvsapm_partition_t *partition, off64_t *offset, libvsapm_error_t **error); int libvsapm_partition_get_size(libvsapm_partition_t *partition, size64_t *size, libvsapm_error_t **error); DESCRIPTION The libvsapm_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 re- turn type. For the actual return values see "libvsapm.h". ENVIRONMENT None FILES None NOTES libvsapm can be compiled with wide character support (wchar_t). To compile libvsapm with wide character support use: ./configure --enable-wide-character-type=yes or define: _UNICODE or UNICODE during compilation. LIBVSAPM_WIDE_CHARACTER_TYPE in libvsapm/features.h can be used to determine if libvsapm was com- piled with wide character support. BUGS Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libvsapm/issues AUTHOR These man pages are generated from "libvsapm.h". COPYRIGHT Copyright (C) 2009-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 libvsapm.h include file libvsapm February 11, 2023 libvsapm(3)
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ENVIRONMENT | FILES | NOTES | BUGS | AUTHOR | COPYRIGHT | SEE ALSO
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=libvsapm&sektion=3&manpath=FreeBSD+Ports+15.0>