NAME

       libregf.h — Library to access the Windows NT Registry File (REGF) format

LIBRARY

       library “libregf”

SYNOPSIS

       #include <libregf.h>

       Support functions

       const char *
       libregf_get_version(void);

       int
       libregf_get_access_flags_read(void);

       int
       libregf_get_codepage(int *codepage, libregf_error_t **error);

       int
       libregf_set_codepage(int codepage, libregf_error_t **error);

       int
       libregf_check_file_signature(const char *filename, libregf_error_t **error);

       Available when compiled with wide character string support:

       int
       libregf_check_file_signature_wide(const wchar_t *filename, libregf_error_t **error);

       Available when compiled with libbfio support:

       int
       libregf_check_file_signature_file_io_handle(libbfio_handle_t *bfio_handle, libregf_error_t **error);

       Notify functions

       void
       libregf_notify_set_verbose(int verbose);

       int
       libregf_notify_set_stream(FILE *stream, libregf_error_t **error);

       int
       libregf_notify_stream_open(const char *filename, libregf_error_t **error);

       int
       libregf_notify_stream_close(libregf_error_t **error);

       Error functions

       void
       libregf_error_free(libregf_error_t **error);

       int
       libregf_error_fprint(libregf_error_t *error, FILE *stream);

       int
       libregf_error_sprint(libregf_error_t *error, char *string, size_t size);

       int
       libregf_error_backtrace_fprint(libregf_error_t *error, FILE *stream);

       int
       libregf_error_backtrace_sprint(libregf_error_t *error, char *string, size_t size);

       File functions

       int
       libregf_file_initialize(libregf_file_t **file, libregf_error_t **error);

       int
       libregf_file_free(libregf_file_t **file, libregf_error_t **error);

       int
       libregf_file_signal_abort(libregf_file_t *file, libregf_error_t **error);

       int
       libregf_file_open(libregf_file_t *file, const char *filename, int access_flags, libregf_error_t **error);

       int
       libregf_file_close(libregf_file_t *file, libregf_error_t **error);

       int
       libregf_file_is_corrupted(libregf_file_t *file, libregf_error_t **error);

       int
       libregf_file_get_ascii_codepage(libregf_file_t *file, int *ascii_codepage, libregf_error_t **error);

       int
       libregf_file_set_ascii_codepage(libregf_file_t *file, int ascii_codepage, libregf_error_t **error);

       int
       libregf_file_get_format_version(libregf_file*_tiluei,nt32*_tajor_versionu,int32_tminor_versionl,ibregf_error_t*error);

       int
       libregf_file_get_type(libregf_file_t *file, uint32_t *file_type, libregf_error_t **error);

       int
       libregf_file_get_root_key(libregf_file_t *file, libregf_key_t **key, libregf_error_t **error);

       int
       libregf_file_get_key_by_utf8_path(libregf_fil*ef_ctloueni,sntt*8u_tf8_strisnigzu,et_t8_string_lengltihb,regf_ke*y*l_itebyr,egf_err*o*re_tror);

       int
       libregf_file_get_key_by_utf16_path(libregf_fi*lfcueioi_nntest*,t1u6t_t16_strsiiunztgef,_t6_string_lengltihb,regf_ke*y*_lteiyb,regf_erro*r*_trror);

       Available when compiled with wide character string support:

       int
       libregf_file_open_wide(libregf_file_t*file,constwchar_t*filename,intaccess_flags,libregf_error_t**error);

       Available when compiled with libbfio support:

       int
       libregf_file_open_file_io_handle(libregf_file*_tillei,bbfio_handle*_tile_io_handliaenc,tcess_flaglsi,bregf_error_t*error);

       Key functions

       int
       libregf_key_free(libregf_key_t **key, libregf_error_t **error);

       int
       libregf_key_is_corrupted(libregf_key_t *key, libregf_error_t **error);

       int
       libregf_key_get_offset(libregf_key_t *key, off64_t *offset, libregf_error_t **error);

       int
       libregf_key_get_name_size(libregf_key_t *key, size_t *name_size, libregf_error_t **error);

       int
       libregf_key_get_name(libregf_key_t *key, uint8_t *name, size_t name_size, libregf_error_t **error);

       int
       libregf_key_get_utf8_name_size(libregf_key_t *key, size_t *utf8_name_size, libregf_error_t **error);

       int
       libregf_key_get_utf8_name(libregf_key_t*key,uint8_t*utf8_name,size_tutf8_name_size,libregf_error_t**error);

       int
       libregf_key_get_utf16_name_size(libregf_key_t *key, size_t *utf16_name_size, libregf_error_t **error);

       int
       libregf_key_get_utf16_name(libregf_key_t*key,uint16_t*utf16_name,size_tutf16_name_size,libregf_error_t**error);

       int
       libregf_key_get_class_name_size(libregf_key_t *key, size_t *class_name_size, libregf_error_t **error);

       int
       libregf_key_get_class_name(libregf_key_t*key,uint8_t*class_name,size_tclass_name_size,libregf_error_t**error);

       int
       libregf_key_get_utf8_class_name_size(libregf_key_t*key,size_t*utf8_class_name_size,libregf_error_t**error);

       int
       libregf_key_get_utf8_class_name(libregf_key_tkeuyi,nt8*_ttf8_class_namsei,zeu_tf8_class_name_sizlei,bregf_error*_terror);

       int
       libregf_key_get_utf16_class_name_size(libregf_key_t*key,size_t*utf16_class_name_size,libregf_error_t**error);

       int
       libregf_key_get_utf16_class_name(libregf_key*_teuyi,nt16*_ttf16_class_namsei,zuet_t16_class_name_silzieb,regf_erro*r*_trror);

       int
       libregf_key_get_last_written_time(libregf_key_t*key,uint64_t*last_written_time, libregf_error_t **error);

       int
       libregf_key_get_security_descriptor_size(libregf_key_tkeys,ize_tsecurity_descriptor_sizel,ibregf_error_t*error);

       int
       libregf_key_get_security_descriptor(libregf_k*uekiyen*_tst,8e_turity_descripstiozsree,_turity_descriptor_silzieb,regf_erro*r*_trror);

       int
       libregf_key_get_number_of_values(libregf_key_t *key, int *number_of_values, libregf_error_t **error);

       int
       libregf_key_get_value(libregf_key_t *key, int value_index,libregf_value_t**value,libregf_error_t**error);

       int
       libregf_key_get_value_by_utf8_name(libregf_k*cuekoiyenn*_stut,t8t_t8_strsiinzuget,_t8_string_lengltihb,regf_valu*e*_talluieb,regf_erro*r*_trror);

       int
       libregf_key_get_value_by_utf16_name(libregf_ke*cuykoi_nntyst*,t1u6t_t16_strsiiunztgef,_t6_string_lenlgitbhr,egf_val*u*ev_ltliuber,egf_err*o*re_tror);

       int
       libregf_key_get_number_of_sub_keys(libregf_key_t *key, int *number_of_sub_keys, libregf_error_t **error);

       int
       libregf_key_get_sub_key(libregf_key_t*key,intsub_key_index,libregf_key_t**sub_key,libregf_error_t**error);

       int
       libregf_key_get_sub_key_by_utf8_name(libregf_ke*ykc_outyni,sn*ttu8t_t8_strsiiunztgef,_t_string_lenlgitbhr,egf_k*e*ys_tb_kiebyr,egf_err*o*re_tror);

       int
       libregf_key_get_sub_key_by_utf8_path(libregf_k*cuekoiyenn*_stut,t8t_t8_strsiiunztgef,_t_string_lenlgitbhr,egf_ke*y*_tub_kleiyb,regf_erro*r*_trror);

       int
       libregf_key_get_sub_key_by_utf16_name(libregf_k*cuekoiyenn_st*t,t1u6t_t16_strsiiunztgef,_t6_string_lenlgitbhr,egf_k*e*ys_tb_kiebyr,egf_er*r*oerr_tor);

       int
       libregf_key_get_sub_key_by_utf16_path(libregf_cukkoieennyyst*_t1ut6t_t16_strsiiunztgef,_t6_string_lenlgitbhr,egf_k*e*ys_tb_kiebyr,egf_err*o*re_tror);

       Value functions

       int
       libregf_value_free(libregf_value_t **value, libregf_error_t **error);

       int
       libregf_value_is_corrupted(libregf_value_t *value, libregf_error_t **error);

       int
       libregf_value_get_offset(libregf_value_t *value, off64_t *offset, libregf_error_t **error);

       int
       libregf_value_get_name_size(libregf_value_t *value, size_t *name_size, libregf_error_t **error);

       int
       libregf_value_get_name(libregf_value_t *value, uint8_t *name, size_t name_size, libregf_error_t **error);

       int
       libregf_value_get_utf8_name_size(libregf_value_t *value, size_t *utf8_name_size, libregf_error_t**error);

       int
       libregf_value_get_utf8_name(libregf_value_tvalue,uint8_t*utf8_name,size_tutf8_name_size,libregf_error_t**error);

       int
       libregf_value_get_utf16_name_size(libregf_value_t *value, size_t*utf16_name_size,libregf_error_t**error);

       int
       libregf_value_get_utf16_name(libregf_value_tvalueu,int16_tutf16_names,ize_ttf16_name_size,libregf_error_t**error);

       int
       libregf_value_get_value_type(libregf_value_t *value, uint32_t *value_type, libregf_error_t **error);

       int
       libregf_value_get_value_data_size(libregf_value_t *value, size_t*value_data_size,libregf_error_t**error);

       int
       libregf_value_get_value_data(libregf_value_tvalueu,int8_tvalue_datas,ize_tvalue_data_size,libregf_error_t**error);

       int
       libregf_value_get_value_32bit(libregf_value_t *value, uint32_t *value_32bit, libregf_error_t **error);

       int
       libregf_value_get_value_64bit(libregf_value_t *value, uint64_t *value_64bit, libregf_error_t **error);

       int
       libregf_value_get_value_utf8_string_size(libregf_value_t*value,size_t*utf8_string_size,libregf_error_t*error);

       int
       libregf_value_get_value_utf8_string(libregf_value*_taluuei,nt8*_ttf8_strinsgi,zeu_tf8_string_sizlei,bregf_error_t*error);

       int
       libregf_value_get_value_utf16_string_size(libregf_value_t*value,size_tutf16_string_sizel,ibregf_error_t*error);

       int
       libregf_value_get_value_utf16_string(libregf_valu*ev_tluuien,t1*6u_tf16_strinsgi,zeu_tf16_string_sizlei,bregf_error*_terror);

       int
       libregf_value_get_value_binary_data_size(libregf_value_t *value, size_t *size, libregf_error_t **error);

       int
       libregf_value_get_value_binary_data(libregf_value_t*value,uint8_t*binary_data,size_tsize,libregf_error_t*error);

DESCRIPTION

       The libregf_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 "libregf.h".

ENVIRONMENT

       None

FILES

       None libregf allows to be compiled with wide character support (wchar_t).

       To compile libregf with wide character support use: ./configure --enable-wide-character-type=yes
        or define: _UNICODE
        or UNICODE
        during compilation.

       LIBREGF_WIDE_CHARACTER_TYPE
        in libregf/features.h can be used to determine if libregf was compiled with wide character support.

BUGS

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

AUTHOR

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

COPYRIGHT

       Copyright (C) 2009-2016, 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 libregf.h include file

libregf                                         December 24, 2015                                     libregf(3)