libfwnt.h — Library to support common Windows NT specific formats

Author

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

Bugs

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

Copyright

       Copyright (C) 2009-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.

Description

       The libfwnt_get_version() function is used to retrieve the library version.

Environment

       None

Files

       None

Name

       libfwnt.h — Library to support common Windows NT specific formats

Return Values

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

Synopsis

#include<libfwnt.h>

       Support functions

       constchar*libfwnt_get_version(void);

       Notify functions

       voidlibfwnt_notify_set_verbose(intverbose);

       intlibfwnt_notify_set_stream(FILE*stream, libfwnt_error_t**error);

       intlibfwnt_notify_stream_open(constchar*filename, libfwnt_error_t**error);

       intlibfwnt_notify_stream_close(libfwnt_error_t**error);

       Error functions

       voidlibfwnt_error_free(libfwnt_error_t**error);

       intlibfwnt_error_fprint(libfwnt_error_t*error, FILE*stream);

       intlibfwnt_error_sprint(libfwnt_error_t*error, char*string, size_tsize);

       intlibfwnt_error_backtrace_fprint(libfwnt_error_t*error, FILE*stream);

       intlibfwnt_error_backtrace_sprint(libfwnt_error_t*error, char*string, size_tsize);

       Security descriptor functions

       intlibfwnt_security_descriptor_initialize(libfwnt_security_descriptor_t**security_descriptor,
           libfwnt_error_t**error);

       intlibfwnt_security_descriptor_free(libfwnt_security_descriptor_t**security_descriptor,
           libfwnt_error_t**error);

       intlibfwnt_security_descriptor_copy_from_byte_stream(libfwnt_security_descriptor_t*security_descriptor,
           constuint8_t*byte_stream, size_tbyte_stream_size, intbyte_order, libfwnt_error_t**error);

       intlibfwnt_security_descriptor_get_owner(libfwnt_security_descriptor_t*security_descriptor,
           libfwnt_security_identifier_t**security_identifier, libfwnt_error_t**error);

       intlibfwnt_security_descriptor_get_group(libfwnt_security_descriptor_t*security_descriptor,
           libfwnt_security_identifier_t**security_identifier, libfwnt_error_t**error);

       intlibfwnt_security_descriptor_get_discretionary_acl(libfwnt_security_descriptor_t*security_descriptor,
           libfwnt_access_control_list_t**access_control_list, libfwnt_error_t**error);

       intlibfwnt_security_descriptor_get_system_acl(libfwnt_security_descriptor_t*security_descriptor,
           libfwnt_access_control_list_t**access_control_list, libfwnt_error_t**error);

       Security identifier (SID) functions

       intlibfwnt_security_identifier_initialize(libfwnt_security_identifier_t**security_identifier,
           libfwnt_error_t**error);

       intlibfwnt_security_identifier_free(libfwnt_security_identifier_t**security_identifier,
           libfwnt_error_t**error);

       intlibfwnt_security_identifier_copy_from_byte_stream(libfwnt_security_identifier_t*security_identifier,
           constuint8_t*byte_stream, size_tbyte_stream_size, intbyte_order, libfwnt_error_t**error);

       intlibfwnt_security_identifier_get_string_size(libfwnt_security_identifier_t*security_identifier,
           size_t*string_size, uint32_tstring_format_flags, libfwnt_error_t**error);

       intlibfwnt_security_identifier_copy_to_utf8_string(libfwnt_security_identifier_t*security_identifier,
           uint8_t*utf8_string,      size_tutf8_string_size,      uint32_tstring_format_flags,
           libfwnt_error_t**error);

       intlibfwnt_security_identifier_copy_to_utf8_string_with_index(libfwnt_security_identifie*rs_tcurity_identifier,
           uint8_t*utf8_string,       size_tutf8_string_size,      size_t*utf8_string_index,
           uint32_tstring_format_flags, libfwnt_error_t**error);

       intlibfwnt_security_identifier_copy_to_utf16_string(libfwnt_security_identifier_t*security_identifier,
           uint16_t*utf16_string,      size_tutf16_string_size,     uint32_tstring_format_flags,
           libfwnt_error_t**error);

       intlibfwnt_security_identifier_copy_to_utf16_string_with_index(libfwnt_security_identifi*esre_turity_identifier,
           uint16_t*utf16_string,      size_tutf16_string_size,      size_t*utf16_string_index,
           uint32_tstring_format_flags, libfwnt_error_t**error);

       intlibfwnt_security_identifier_copy_to_utf32_string(libfwnt_security_identifier_t*security_identifier,
           uint32_t*utf32_string,      size_tutf32_string_size,     uint32_tstring_format_flags,
           libfwnt_error_t**error);

       intlibfwnt_security_identifier_copy_to_utf32_string_with_index(libfwnt_security_identifi*esre_turity_identifier,
           uint32_t*utf32_string,      size_tutf32_string_size,      size_t*utf32_string_index,
           uint32_tstring_format_flags, libfwnt_error_t**error);

       Access control list (ACL) functions

       intlibfwnt_access_control_list_free(libfwnt_access_control_list_t**access_control_list,
           libfwnt_error_t**error);

       intlibfwnt_access_control_list_get_number_of_entries(libfwnt_access_control_list_t*access_control_list,
           int*number_of_entries, libfwnt_error_t**error);

       intlibfwnt_access_control_list_get_entry_by_index(libfwnt_access_control_list_t*access_control_list,
           intentry_index, libfwnt_access_control_entry_t**access_control_entry, libfwnt_error_t**error);

       Access control entry (ACE) functions

       intlibfwnt_access_control_entry_free(libfwnt_access_control_entry_t**access_control_entry,
           libfwnt_error_t**error);

       intlibfwnt_access_control_entry_get_type(libfwnt_access_control_entry_t*access_control_entry,
           uint8_t*type, libfwnt_error_t**error);

       intlibfwnt_access_control_entry_get_flags(libfwnt_access_control_entry_t*access_control_entry,
           uint8_t*flags, libfwnt_error_t**error);

       intlibfwnt_access_control_entry_get_access_mask(libfwnt_access_control_entry_t*access_control_entry,
           uint32_t*access_mask, libfwnt_error_t**error);

       intlibfwnt_access_control_entry_get_security_identifier(libfwnt_access_control_entry_t*access_control_entry,
           libfwnt_security_identifier_t**security_identifier, libfwnt_error_t**error);

       LZNT1 functions

       intlibfwnt_lznt1_decompress(constuint8_t*compressed_data,      size_tcompressed_data_size,
           uint8_t*uncompressed_data, size_t*uncompressed_data_size, libfwnt_error_t**error);

       LZX functions

       intlibfwnt_lzx_decompress(constuint8_t*compressed_data,      size_tcompressed_data_size,
           uint8_t*uncompressed_data, size_t*uncompressed_data_size, libfwnt_error_t**error);

       LZXPRESS functions

       intlibfwnt_lzxpress_decompress(constuint8_t*compressed_data,     size_tcompressed_data_size,
           uint8_t*uncompressed_data, size_t*uncompressed_data_size, libfwnt_error_t**error);

       intlibfwnt_lzxpress_huffman_decompress(constuint8_t*compressed_data,   size_tcompressed_data_size,
           uint8_t*uncompressed_data, size_t*uncompressed_data_size, libfwnt_error_t**error);