NDEVR
API Documentation
RegistryEntry

Provides read and write access to a single Windows registry entry identified by hive, path, and variable name. More...

Collaboration diagram for RegistryEntry:
[legend]

Public Member Functions

 RegistryEntry (const StringView &h_key, const StringView &path, const StringView &variable)
 Constructs a RegistryEntry from an explicit hive key, path, and variable name.
 RegistryEntry (const StringView &path, const StringView &variable)
 Constructs a RegistryEntry from a separate path and variable name.
 RegistryEntry (const StringView &path_and_variable)
 Constructs a RegistryEntry by parsing a combined path and variable string.
String getValue ()
 Reads the current value of this registry entry as a string.
bool setValue (const StringView &value) const
 Writes a string value to this registry entry.

Static Public Member Functions

static Buffer< StringViewAvailableKeys ()
 Returns the list of available root registry hive key names.

Public Attributes

String h_key
 The root hive key name (e.g., "HKEY_LOCAL_MACHINE").
String path
 The registry key path beneath the hive.
RegistyEntryType type = RegistyEntryType::e_sz
 The expected data type of the registry value.
String variable
 The name of the registry value within the key.

Detailed Description

Provides read and write access to a single Windows registry entry identified by hive, path, and variable name.


Definition at line 29 of file RegistryEntry.h.

Constructor & Destructor Documentation

◆ RegistryEntry() [1/3]

RegistryEntry::RegistryEntry ( const StringView & path_and_variable)

Constructs a RegistryEntry by parsing a combined path and variable string.

Parameters
[in]path_and_variableThe full registry path including the variable name.

◆ RegistryEntry() [2/3]

RegistryEntry::RegistryEntry ( const StringView & path,
const StringView & variable )

Constructs a RegistryEntry from a separate path and variable name.

Parameters
[in]pathThe registry key path.
[in]variableThe name of the registry value.

References path, and variable.

◆ RegistryEntry() [3/3]

RegistryEntry::RegistryEntry ( const StringView & h_key,
const StringView & path,
const StringView & variable )

Constructs a RegistryEntry from an explicit hive key, path, and variable name.

Parameters
[in]h_keyThe root hive key (e.g., HKEY_LOCAL_MACHINE).
[in]pathThe registry key path beneath the hive.
[in]variableThe name of the registry value.

References h_key, path, and variable.

Member Function Documentation

◆ AvailableKeys()

Buffer< StringView > RegistryEntry::AvailableKeys ( )
static

Returns the list of available root registry hive key names.

Returns
A Buffer of StringViews representing the known hive keys.

◆ getValue()

String RegistryEntry::getValue ( )

Reads the current value of this registry entry as a string.

Returns
The registry value as a String.

◆ setValue()

bool RegistryEntry::setValue ( const StringView & value) const

Writes a string value to this registry entry.

Parameters
[in]valueThe string value to write.
Returns
True if the value was written successfully, false otherwise.

The documentation for this class was generated from the following file: