libbfoverlay(3)

okay so bestie, welcome to the libbfoverlay(3) manual page for libbfoverlay.h — the library that provides basic file overlay support. We're keeping every single function, caveat, and tiny detail, but making it actually fun to read. 💅✨

---

🌸 NAME 🌸

libbfoverlay.h — Library to provide basic file overlay support. That's the whole assignment, bestie: basic file overlay support, no cap. 🫶

✨ SYNOPSIS ✨

Include it like this:

#include <libbfoverlay.h>

💖 Support functions 💖

const char *
libbfoverlay_get_version(void);

int
libbfoverlay_get_codepage(int *codepage, libbfoverlay_error_t **error);

int
libbfoverlay_set_codepage(int codepage, libbfoverlay_error_t **error);

🎀 Notify functions 🎀

void
libbfoverlay_notify_set_verbose(int verbose);

int
libbfoverlay_notify_set_stream(FILE *stream,
    libbfoverlay_error_t **error);

int
libbfoverlay_notify_stream_open(const char *filename,
    libbfoverlay_error_t **error);

int
libbfoverlay_notify_stream_close(libbfoverlay_error_t **error);

🦋 Error functions 🦋

void
libbfoverlay_error_free(libbfoverlay_error_t **error);

int
libbfoverlay_error_fprint(libbfoverlay_error_t *error, FILE *stream);

int
libbfoverlay_error_sprint(libbfoverlay_error_t *error, char *string,
    size_t size);

int
libbfoverlay_error_backtrace_fprint(libbfoverlay_error_t *error,
    FILE *stream);

int
libbfoverlay_error_backtrace_sprint(libbfoverlay_error_t *error,
    char *string, size_t size);

🌈 Handle functions 🌈

int
libbfoverlay_handle_initialize(libbfoverlay_handle_t **handle,
    libbfoverlay_error_t **error);

int
libbfoverlay_handle_free(libbfoverlay_handle_t **handle,
    libbfoverlay_error_t **error);

int
libbfoverlay_handle_signal_abort(libbfoverlay_handle_t *handle,
    libbfoverlay_error_t **error);

int
libbfoverlay_handle_open(libbfoverlay_handle_t *handle,
    const char *filename, int access_flags,
    libbfoverlay_error_t **error);

int
libbfoverlay_handle_open_data_files(libbfoverlay_handle_t *handle,
    libbfoverlay_error_t **error);

int
libbfoverlay_handle_close(libbfoverlay_handle_t *handle,
    libbfoverlay_error_t **error);

ssize_t
libbfoverlay_handle_read_buffer(libbfoverlay_handle_t *handle,
    uint8_t *buffer, size_t size, libbfoverlay_error_t **error);

ssize_t
libbfoverlay_handle_read_buffer_at_offset(libbfoverlay_handle_t *handle,
    uint8_t *buffer, size_t buffer_size, off64_t offset,
    libbfoverlay_error_t **error);

ssize_t
libbfoverlay_handle_write_buffer(libbfoverlay_handle_t *handle,
    const uint8_t *buffer, size_t size, libbfoverlay_error_t **error);

ssize_t
libbfoverlay_handle_write_buffer_at_offset(libbfoverlay_handle_t *handle,
    const uint8_t *buffer, size_t buffer_size, off64_t offset,
    libbfoverlay_error_t **error);

off64_t
libbfoverlay_handle_seek_offset(libbfoverlay_handle_t *handle,
    off64_t offset, int whence, libbfoverlay_error_t **error);

int
libbfoverlay_handle_resize(libbfoverlay_handle_t *handle, size64_t size,
    libbfoverlay_error_t **error);

int
libbfoverlay_handle_get_offset(libbfoverlay_handle_t *handle,
    off64_t *offset, libbfoverlay_error_t **error);

int
libbfoverlay_handle_get_size(libbfoverlay_handle_t *handle,
    size64_t *size, libbfoverlay_error_t **error);

Available when compiled with wide character string support:

int
libbfoverlay_handle_open_wide(libbfoverlay_handle_t *handle,
    const wchar_t *filename, int access_flags,
    libbfoverlay_error_t **error);

Available when compiled with libbfio support:

int
libbfoverlay_handle_open_file_io_handle(libbfoverlay_handle_t *handle,
    libbfio_handle_t *file_io_handle, int access_flags,
    libbfoverlay_error_t **error);

int
libbfoverlay_handle_open_data_files_file_io_pool(libbfoverlay_handle_t *handle,
    libbfio_pool_t *file_io_pool, libbfoverlay_error_t **error);

💜 DESCRIPTION 💜

The libbfoverlay_get_version() function is used to retrieve the library version. That's the one called out here, bestie — version retrieval, iconic behavior. 👑

🔥 RETURN VALUES 🔥

Most of the functions return NULL or -1 on error, dependent on the return type. For the actual return values see "libbfoverlay.h". The header is the source of truth, periodt. 💅

🌸 ENVIRONMENT 🌸

None.

🎀 FILES 🎀

None.

✨ NOTES ✨

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

To compile libbfoverlay with wide character support use:

./configure --enable-wide-character-type=yes

or define: _UNICODE or UNICODE during compilation.

LIBBFOVERLAY_WIDE_CHARACTER_TYPE in libbfoverlay/features.h can be used to determine if libbfoverlay was compiled with wide character support. Vibe check via features header, iykyk. 🦋

💀 BUGS 💀

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

👑 AUTHOR 👑

These man pages are generated from "libbfoverlay.h". The header is the blueprint, bestie. 💖

🌈 COPYRIGHT 🌈

Copyright (C) 2020-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 libbfoverlay.h include file — that's the SEE ALSO, short and sweet. 🎀

---

Source/version: libbfoverlay · page: libbfoverlay(3) · date: July 17, 2021 — mwah, bye bestie 💖🌈