Registry_GetProtectedString()

Examples


The Registry_GetProtectedString() function retrieves and decrypts the specified value from the HKEY_CURRENT_USER subtree and key.

Syntax

Registry_GetProtectedString(key, value_name, value {, entropy}{, error_code})

Parameters

key – A string specifying the path of the key that contains the value to retrieve. The path value begins with the key name followed by the subkey names. The values in the path are separated by backslash (\) characters.

value_name – The name of the value to retrieve.

value – A returned string containing the value.

entropy – An optional string that contains additional characters, such as a password, that are used when decrypting the value. If an entropy value was used when the protected string was set, that same entropy value must be used when the string is read from the registry.

error_code – An optional returned long integer that contains the error code that was returned. The error codes are defined in the WinError.h file of the Windows SDK.

Return value

A boolean indicating the result. The value true indicates the function succeeded, while false indicates it did not.


Documentation Feedback