NAME

libfguid.h — Library to support the GUID/UUID format

LIBRARY

library “libfguid”

SYNOPSIS

#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.

RETURN VALUES

Most of the functions return NULL or -1 on error, dependent on the return type. For the actual return values refer to libfguid.h

ENVIRONMENT

None

FILES

None

NOTES

BUGS

Please report bugs of any kind to <joachim.metz@gmail.com> or on the project website: http://code.google.com/p/libfguid/

AUTHOR

These man pages were written by Joachim Metz.

COPYRIGHT

Copyright (c) 2010-2013, 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