libftxf(3)

🦋 libftxf — the library for accessing the Transactional NTFS (TxF) format 💅

okay so this is libftxf, section 3 of the manual pages — yes bestie, a whole library for reading the TxF (Transactional NTFS) format, and this page is literally your tour guide ✨

---

🌸 NAME

libftxf.h — the Library to access the Transactional NTFS (TxF) format. that's it, that's the whole vibe 🎀

---

✨ SYNOPSIS

pull it in like this, no cap:

#include <libftxf.h>

🫶 Support functions

const char *
libftxf_get_version(void);

😭 Error functions

void
libftxf_error_free(libftxf_error_t **error);

int
libftxf_error_fprint(libftxf_error_t *error, FILE *stream);

int
libftxf_error_sprint(libftxf_error_t *error, char *string, size_t size);

int
libftxf_error_backtrace_fprint(libftxf_error_t *error, FILE *stream);

int
libftxf_error_backtrace_sprint(libftxf_error_t *error, char *string,
    size_t size);

🔥 Record functions

int
libftxf_record_initialize(libftxf_record_t **txf_record,
    libftxf_error_t **error);

int
libftxf_record_free(libftxf_record_t **txf_record,
    libftxf_error_t **error);

int
libftxf_record_copy_from_byte_stream(libftxf_record_t *txf_record,
    const uint8_t *byte_stream, size_t byte_stream_size,
    libftxf_error_t **error);

---

🧚 DESCRIPTION

so, the libftxf_get_version() function is the function you call when you wanna retrieve the library version. it's giving "hi, what's your name" energy, and honestly? iconic ⭐ that's the whole description, bestie — the original page keeps it short and we respect that 🙈

---

👑 RETURN VALUES

most of these functions return NULL or -1 on error — which one you get depends on the return type, iykyk 💅 for the actual return values, go look at "libftxf.h" — that's where the receipts are, fr fr 🍓

---

🌈 ENVIRONMENT

None. literally nothing. no environment variables, no little secret settings hiding in your shell. clean vibes only ✨

---

🎀 FILES

None. not a single file path to remember here. you're welcome 🫶

---

💀 BUGS

found a bug? don't suffer in silence, bestie 😭 please report bugs of any kind on the project issue tracker:

https://github.com/libyal/libftxf/issues

any kind. all kinds. they want to hear it 💖

---

🧚 AUTHOR

these man pages are generated from "libftxf.h" — so yes, the header wrote its own biography, main character energy honestly 👑

---

💜 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. like, zero warranty, none, don't come for them if it breaks 🔥

---

🦋 SEE ALSO

• the libftxf.h include file — that's the one, that's the reference 💅

---

and that's the page, bestie!! this was libftxf from the Library Functions Manual, dated April 2, 2019 — ty for coming to my TED talk, mwah 💖🎀✨