Registry APIs

The registry is a database under eRTOS in which applications and system components store and retrieve configuration data. The data is stored in a text-based RtConfig.reg file. Applications use the registry API to retrieve, modify, or delete registry data.

You should not edit registry data that does not belong to your application unless it is absolutely necessary. If there is an error in the registry, eRTOS may not function properly.

The registry is a file-based database that contains keys. Keys are containers that consist of other keys (subkeys) or values. Both keys and values borrow their naming convention from the Windows registry database. Values store different kinds of data and can be one of these data types:

Only these case-sensitive predefined keys are supported:

Note: APIs that are not explicitly documented as supported are not guaranteed to work. You should thoroughly test any code that uses undocumented functions.

Registry Function Notes

RegCloseKey

Closes a handle to the specified registry key.

RegCreateKey

Creates Key.

RegCreateKeyEx

Creates the specified key.

RegDeleteKey

Deletes a subkey and its values

RegDeleteKeyEx

Deletes a subkey and its values from the specified platform specific view of the registry.

RegDeleteValue

Removes the specified value from the specified registry key.

RegEnumValue

Enumerates the values for the specified open registry key.

RegOpenKey

Opens the specified registry key.

RegOpenKeyEx

Opens the specified registry key

RegQueryValueEx

Retrieves the data of a specified registry key.

RegSetValueEx

Sets the value of registry key.