libfguid(3)

🎀 NAME 🎀

libfguid(3) — from the Library Functions Manual — is the page for libfguid.h, aka the Library to support the GUID/UUID format. Yes bestie, it's giving UUID realness. 💅

---

✨ SYNOPSIS ✨

Okay so here's the whole function lineup, copied with love and exactness. No cap.

#include <libfguid.h>

Support functions

const char *
libfguid_get_version(void);

Error functions

void
libfguid_error_free(libfguid_error_t **error);

int
libfguid_error_fprint(libfguid_error_t *error, FILE *stream);

int
libfguid_error_sprint(libfguid_error_t *error, char *string,
    size_t size);

int
libfguid_error_backtrace_fprint(libfguid_error_t *error, FILE *stream);

int
libfguid_error_backtrace_sprint(libfguid_error_t *error, char *string,
    size_t size);

Identifier functions

int
libfguid_identifier_initialize(libfguid_identifier_t **identifier,
    libfguid_error_t **error);

int
libfguid_identifier_free(libfguid_identifier_t **identifier,
    libfguid_error_t **error);

int
libfguid_identifier_copy_from_byte_stream(libfguid_identifier_t *identifier,
    const uint8_t *byte_stream, size_t byte_stream_size, int byte_order,
    libfguid_error_t **error);

int
libfguid_identifier_copy_to_byte_stream(libfguid_identifier_t *identifier,
    uint8_t *byte_stream, size_t byte_stream_size, int byte_order,
    libfguid_error_t **error);

int
libfguid_identifier_get_string_size(libfguid_identifier_t *identifier,
    size_t *string_size, uint32_t string_format_flags,
    libfguid_error_t **error);

int
libfguid_identifier_copy_from_utf8_string(libfguid_identifier_t *identifier,
    const uint8_t *utf8_string, size_t utf8_string_length,
    uint32_t string_format_flags, libfguid_error_t **error);

int
libfguid_identifier_copy_from_utf8_string_with_index(libfguid_identifier_t *identifier,
    const uint8_t *utf8_string, size_t utf8_string_length,
    size_t *utf8_string_index, uint32_t string_format_flags,
    libfguid_error_t **error);

int
libfguid_identifier_copy_to_utf8_string(libfguid_identifier_t *identifier,
    uint8_t *utf8_string, size_t utf8_string_size,
    uint32_t string_format_flags, libfguid_error_t **error);

int
libfguid_identifier_copy_to_utf8_string_with_index(libfguid_identifier_t *identifier,
    uint8_t *utf8_string, size_t utf8_string_size,
    size_t *utf8_string_index, uint32_t string_format_flags,
    libfguid_error_t **error);

int
libfguid_identifier_copy_from_utf16_string(libfguid_identifier_t *identifier,
    const uint16_t *utf16_string, size_t utf16_string_length,
    uint32_t string_format_flags, libfguid_error_t **error);

int
libfguid_identifier_copy_from_utf16_string_with_index(libfguid_identifier_t *identifier,
    const uint16_t *utf16_string, size_t utf16_string_length,
    size_t *utf16_string_index, uint32_t string_format_flags,
    libfguid_error_t **error);

int
libfguid_identifier_copy_to_utf16_string(libfguid_identifier_t *identifier,
    uint16_t *utf16_string, size_t utf16_string_size,
    uint32_t string_format_flags, libfguid_error_t **error);

int
libfguid_identifier_copy_to_utf16_string_with_index(libfguid_identifier_t *identifier,
    uint16_t *utf16_string, size_t utf16_string_size,
    size_t *utf16_string_index, uint32_t string_format_flags,
    libfguid_error_t **error);

int
libfguid_identifier_copy_from_utf32_string(libfguid_identifier_t *identifier,
    const uint32_t *utf32_string, size_t utf32_string_length,
    uint32_t string_format_flags, libfguid_error_t **error);

int
libfguid_identifier_copy_from_utf32_string_with_index(libfguid_identifier_t *identifier,
    const uint32_t *utf32_string, size_t utf32_string_length,
    size_t *utf32_string_index, uint32_t string_format_flags,
    libfguid_error_t **error);

int
libfguid_identifier_copy_to_utf32_string(libfguid_identifier_t *identifier,
    uint32_t *utf32_string, size_t utf32_string_size,
    uint32_t string_format_flags, libfguid_error_t **error);

int
libfguid_identifier_copy_to_utf32_string_with_index(libfguid_identifier_t *identifier,
    uint32_t *utf32_string, size_t utf32_string_size,
    size_t *utf32_string_index, uint32_t string_format_flags,
    libfguid_error_t **error);

---

🔍 DESCRIPTION 🔍

The libfguid_get_version() function is used to retrieve the library version. That's the whole description, bestie — simple, iconic, done. ✨

---

💀 RETURN VALUES 💀

Most of the functions return NULL or -1 on error, dependent on the return type. For the actual return values, see "libfguid.h". So like, don't guess — the header is the main character here. 👑

---

🌸 ENVIRONMENT 🌸

None. Literally none. No environment variables to vibe-check. 🫶

---

🎀 FILES 🎀

None. No files, no paths, no drama. 💅

---

🐛 BUGS 🐛

Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libfguid/issues — don't gatekeep the bugs, bestie. 😭

---

👑 AUTHOR 👑

These man pages are generated from "libfguid.h". The header is the source of truth, iykyk. 🫶

---

💖 COPYRIGHT 💖

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

---

Okay that's the whole page, bestie. 💖 This gem came from source/version libfguid, dated March 25, 2019 — and yeah, it's the libfguid(3) manual. Slay and stay UUID-pilled. ✨