---
name: "libcreg"
section: "3"
platform: "linux"
package: "libcreg-dev"
version: "20240419-1+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/libcreg"
---

# libcreg(3)

Library to access the Windows 9x/Me Registry File (CREG) format

## NAME

**libcreg.h** – Library to access the Windows 9x/Me Registry File (CREG) format

## SYNOPSIS

**#include \<libcreg.h\>**

Support functions

*const* *char* *\**\

**libcreg\_get\_version**(*void*);

*int*\

**libcreg\_get\_access\_flags\_read**(*void*);

*int*\

**libcreg\_get\_codepage**(*int \*codepage*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_set\_codepage**(*int codepage*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_check\_file\_signature**(*const char \*filename*, *libcreg\_error\_t \*\*error*);

Available when compiled with wide character string support:

*int*\

**libcreg\_check\_file\_signature\_wide**(*const wchar\_t \*filename*, *libcreg\_error\_t \*\*error*);

Available when compiled with libbfio support:

*int*\

**libcreg\_check\_file\_signature\_file\_io\_handle**(*libbfio\_handle\_t \*bfio\_handle*, *libcreg\_error\_t \*\*error*);

Notify functions

*void*\

**libcreg\_notify\_set\_verbose**(*int verbose*);

*int*\

**libcreg\_notify\_set\_stream**(*FILE \*stream*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_notify\_stream\_open**(*const char \*filename*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_notify\_stream\_close**(*libcreg\_error\_t \*\*error*);

Error functions

*void*\

**libcreg\_error\_free**(*libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_error\_fprint**(*libcreg\_error\_t \*error*, *FILE \*stream*);

*int*\

**libcreg\_error\_sprint**(*libcreg\_error\_t \*error*, *char \*string*, *size\_t size*);

*int*\

**libcreg\_error\_backtrace\_fprint**(*libcreg\_error\_t \*error*, *FILE \*stream*);

*int*\

**libcreg\_error\_backtrace\_sprint**(*libcreg\_error\_t \*error*, *char \*string*, *size\_t size*);

File functions

*int*\

**libcreg\_file\_initialize**(*libcreg\_file\_t \*\*file*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_free**(*libcreg\_file\_t \*\*file*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_signal\_abort**(*libcreg\_file\_t \*file*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_open**(*libcreg\_file\_t \*file*, *const char \*filename*, *int access\_flags*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_close**(*libcreg\_file\_t \*file*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_is\_corrupted**(*libcreg\_file\_t \*file*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_get\_ascii\_codepage**(*libcreg\_file\_t \*file*, *int \*ascii\_codepage*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_set\_ascii\_codepage**(*libcreg\_file\_t \*file*, *int ascii\_codepage*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_get\_format\_version**(*libcreg\_file\_t \*file*, *uint16\_t \*major\_version*, *uint16\_t \*minor\_version*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_get\_type**(*libcreg\_file\_t \*file*, *uint32\_t \*file\_type*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_get\_root\_key**(*libcreg\_file\_t \*file*, *libcreg\_key\_t \*\*root\_key*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_get\_key\_by\_utf8\_path**(*libcreg\_file\_t \*file*, *const uint8\_t \*utf8\_string*, *size\_t utf8\_string\_length*, *libcreg\_key\_t \*\*key*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_file\_get\_key\_by\_utf16\_path**(*libcreg\_file\_t \*file*, *const uint16\_t \*utf16\_string*, *size\_t utf16\_string\_length*, *libcreg\_key\_t \*\*key*, *libcreg\_error\_t \*\*error*);

Available when compiled with wide character string support:

*int*\

**libcreg\_file\_open\_wide**(*libcreg\_file\_t \*file*, *const wchar\_t \*filename*, *int access\_flags*, *libcreg\_error\_t \*\*error*);

Available when compiled with libbfio support:

*int*\

**libcreg\_file\_open\_file\_io\_handle**(*libcreg\_file\_t \*file*, *libbfio\_handle\_t \*file\_io\_handle*, *int access\_flags*, *libcreg\_error\_t \*\*error*);

Key functions

*int*\

**libcreg\_key\_free**(*libcreg\_key\_t \*\*key*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_is\_corrupted**(*libcreg\_key\_t \*key*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_offset**(*libcreg\_key\_t \*key*, *off64\_t \*offset*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_name\_size**(*libcreg\_key\_t \*key*, *size\_t \*string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_name**(*libcreg\_key\_t \*key*, *uint8\_t \*string*, *size\_t string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_utf8\_name\_size**(*libcreg\_key\_t \*key*, *size\_t \*utf8\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_utf8\_name**(*libcreg\_key\_t \*key*, *uint8\_t \*utf8\_string*, *size\_t utf8\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_utf16\_name\_size**(*libcreg\_key\_t \*key*, *size\_t \*utf16\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_utf16\_name**(*libcreg\_key\_t \*key*, *uint16\_t \*utf16\_string*, *size\_t utf16\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_number\_of\_values**(*libcreg\_key\_t \*key*, *int \*number\_of\_values*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_value\_by\_index**(*libcreg\_key\_t \*key*, *int value\_index*, *libcreg\_value\_t \*\*value*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_value\_by\_utf8\_name**(*libcreg\_key\_t \*key*, *const uint8\_t \*utf8\_string*, *size\_t utf8\_string\_length*, *libcreg\_value\_t \*\*value*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_value\_by\_utf16\_name**(*libcreg\_key\_t \*key*, *const uint16\_t \*utf16\_string*, *size\_t utf16\_string\_length*, *libcreg\_value\_t \*\*value*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_number\_of\_sub\_keys**(*libcreg\_key\_t \*key*, *int \*number\_of\_sub\_keys*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_sub\_key\_by\_index**(*libcreg\_key\_t \*key*, *int sub\_key\_index*, *libcreg\_key\_t \*\*sub\_key*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_sub\_key\_by\_utf8\_name**(*libcreg\_key\_t \*key*, *const uint8\_t \*utf8\_string*, *size\_t utf8\_string\_length*, *libcreg\_key\_t \*\*sub\_key*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_sub\_key\_by\_utf8\_path**(*libcreg\_key\_t \*key*, *const uint8\_t \*utf8\_string*, *size\_t utf8\_string\_length*, *libcreg\_key\_t \*\*sub\_key*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_sub\_key\_by\_utf16\_name**(*libcreg\_key\_t \*key*, *const uint16\_t \*utf16\_string*, *size\_t utf16\_string\_length*, *libcreg\_key\_t \*\*sub\_key*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_key\_get\_sub\_key\_by\_utf16\_path**(*libcreg\_key\_t \*key*, *const uint16\_t \*utf16\_string*, *size\_t utf16\_string\_length*, *libcreg\_key\_t \*\*sub\_key*, *libcreg\_error\_t \*\*error*);

Value functions

*int*\

**libcreg\_value\_free**(*libcreg\_value\_t \*\*value*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_is\_corrupted**(*libcreg\_value\_t \*value*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_offset**(*libcreg\_value\_t \*value*, *off64\_t \*offset*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_name\_size**(*libcreg\_value\_t \*value*, *size\_t \*string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_name**(*libcreg\_value\_t \*value*, *uint8\_t \*string*, *size\_t string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_utf8\_name\_size**(*libcreg\_value\_t \*value*, *size\_t \*utf8\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_utf8\_name**(*libcreg\_value\_t \*value*, *uint8\_t \*utf8\_string*, *size\_t utf8\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_utf16\_name\_size**(*libcreg\_value\_t \*value*, *size\_t \*utf16\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_utf16\_name**(*libcreg\_value\_t \*value*, *uint16\_t \*utf16\_string*, *size\_t utf16\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_type**(*libcreg\_value\_t \*value*, *uint32\_t \*value\_type*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_data\_size**(*libcreg\_value\_t \*value*, *size\_t \*value\_data\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_data**(*libcreg\_value\_t \*value*, *uint8\_t \*value\_data*, *size\_t value\_data\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_32bit**(*libcreg\_value\_t \*value*, *uint32\_t \*value\_32bit*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_64bit**(*libcreg\_value\_t \*value*, *uint64\_t \*value\_64bit*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_utf8\_string\_size**(*libcreg\_value\_t \*value*, *size\_t \*utf8\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_utf8\_string**(*libcreg\_value\_t \*value*, *uint8\_t \*utf8\_string*, *size\_t utf8\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_utf16\_string\_size**(*libcreg\_value\_t \*value*, *size\_t \*utf16\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_utf16\_string**(*libcreg\_value\_t \*value*, *uint16\_t \*utf16\_string*, *size\_t utf16\_string\_size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_binary\_data\_size**(*libcreg\_value\_t \*value*, *size\_t \*size*, *libcreg\_error\_t \*\*error*);

*int*\

**libcreg\_value\_get\_value\_binary\_data**(*libcreg\_value\_t \*value*, *uint8\_t \*binary\_data*, *size\_t size*, *libcreg\_error\_t \*\*error*);

## DESCRIPTION

The **libcreg\_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 "libcreg.h".

## ENVIRONMENT

None

## FILES

None

## NOTES

libcreg can be compiled with wide character support (wchar\_t).

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

*LIBCREG\_WIDE\_CHARACTER\_TYPE*\
  in libcreg/features.h can be used to determine if libcreg was compiled with wide character support.

## BUGS

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

## AUTHOR

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

## COPYRIGHT

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