NAME¶

libfusn.h — Library to access the Update Sequence Number (USN) Journal format

SYNOPSIS¶

#include <libfusn.h>

Support functions
const char *
libfusn_get_version(void);

Error functions
void
libfusn_error_free(libfusn_error_t **error);

int
libfusn_error_fprint(libfusn_error_t *error, FILE *stream);

int
libfusn_error_sprint(libfusn_error_t *error, char *string, size_t size);

int
libfusn_error_backtrace_fprint(libfusn_error_t *error, FILE *stream);

int
libfusn_error_backtrace_sprint(libfusn_error_t *error, char *string, size_t size);

Record functions
int
libfusn_record_initialize(libfusn_record_t **usn_record, libfusn_error_t **error);

int
libfusn_record_free(libfusn_record_t **usn_record, libfusn_error_t **error);

int
libfusn_record_copy_from_byte_stream(libfusn_record_t *usn_record, const uint8_t *byte_stream, size_t byte_stream_size, libfusn_error_t **error);

int
libfusn_record_get_size(libfusn_record_t *usn_record, uint32_t *size, libfusn_error_t **error);

int
libfusn_record_get_update_time(libfusn_record_t *record, uint64_t *update_time, libfusn_error_t **error);

int
libfusn_record_get_file_reference(libfusn_record_t *record, uint64_t *file_reference, libfusn_error_t **error);

int
libfusn_record_get_parent_file_reference(libfusn_record_t *record, uint64_t *parent_file_reference, libfusn_error_t **error);

int
libfusn_record_get_update_sequence_number(libfusn_record_t *record, uint64_t *update_sequence_number, libfusn_error_t **error);

int
libfusn_record_get_update_reason_flags(libfusn_record_t *record, uint32_t *update_reason_flags, libfusn_error_t **error);

int
libfusn_record_get_update_source_flags(libfusn_record_t *record, uint32_t *update_source_flags, libfusn_error_t **error);

int
libfusn_record_get_file_attribute_flags(libfusn_record_t *record, uint32_t *file_attribute_flags, libfusn_error_t **error);

int
libfusn_record_get_utf8_name_size(libfusn_record_t *record, size_t *utf8_string_size, libfusn_error_t **error);

int
libfusn_record_get_utf8_name(libfusn_record_t *record, uint8_t *utf8_string, size_t utf8_string_size, libfusn_error_t **error);

int
libfusn_record_get_utf16_name_size(libfusn_record_t *record, size_t *utf16_string_size, libfusn_error_t **error);

int
libfusn_record_get_utf16_name(libfusn_record_t *record, uint16_t *utf16_string, size_t utf16_string_size, libfusn_error_t **error);

DESCRIPTION¶

The libfusn_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 see "libfusn.h".

ENVIRONMENT¶

None

FILES¶

None

BUGS¶

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

AUTHOR¶

These man pages are generated from "libfusn.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 libfusn.h include file