libftxr(3)

💖 libftxr(3) — libftxr.h is giving TxR access 💖

okay so welcome to this Library Functions Manual page for libftxr(3), bestie. We’re talking about libftxr.h, the library to access the Transactional Registry (TxR) format. No cap. ✨

---

✨ NAME ✨

libftxr.h — Library to access the Transactional Registry (TxR) format.

🎀 SYNOPSIS 🎀

First things first, the include is literally this:

#include <libftxr.h>

🌸 Support functions 🌸

const char *
libftxr_get_version(void);

💅 Error functions 💅

void
libftxr_error_free(libftxr_error_t **error);

int
libftxr_error_fprint(libftxr_error_t *error, FILE *stream);

int
libftxr_error_sprint(libftxr_error_t *error, char *string, size_t size);

int
libftxr_error_backtrace_fprint(libftxr_error_t *error, FILE *stream);

int
libftxr_error_backtrace_sprint(libftxr_error_t *error, char *string,
    size_t size);

🦋 Record functions 🦋

int
libftxr_record_initialize(libftxr_record_t **txr_record,
    libftxr_error_t **error);

int
libftxr_record_free(libftxr_record_t **txr_record,
    libftxr_error_t **error);

int
libftxr_record_copy_from_byte_stream(libftxr_record_t *txr_record,
    const uint8_t *byte_stream, size_t byte_stream_size,
    libftxr_error_t **error);

💅 DESCRIPTION 💅

The libftxr_get_version() function is used to retrieve the library version. That’s the whole description, and honestly? It ate. 💖

🔥 RETURN VALUES 🔥

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

bestie, don’t guess the return values — check the header. That’s the vibe check. 👑

🌸 ENVIRONMENT 🌸

None. Zero environment variables. Nothing to export, nothing to unset. iconic.

🦋 FILES 🦋

None. No files here either. Literally none.

💀 BUGS 💀

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

no gatekeeping bugs, okay? send them to the tracker. 💅

👑 AUTHOR 👑

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

🌈 COPYRIGHT 🌈

Copyright (C) 2011-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 libftxr.h include file

---

💖 cute little sign-off: this page’s source/version is libftxr, dated April 3, 2019 — and yes, it’s the libftxr(3) manual. now go be a main character. 🫶