regGetVal--Get registry value

Reference Guide › AutoShell › AutoShell Core Reference › AutoShell Functions › regGetVal--Get Registry Value (Function)

regGetVal--Get Registry Value (Function)

The regGetVal function retrieves the setting of the value valName under the registry key specified by key on the local system or a remote system.

The function has the following syntax:

regGetVal(sKey, sValName)

sKey: Specifies the registry key.
sValName: Specifies the value.

If the specified value exists, the function returns a polymorphic value representing the setting of the specified value. The type of the registry value determines the type of the return value.

REG_DWORD values are returned as numeric
REG_SZ and REG_EXPAND_SZ as string
REG_MULTI_SZ as an array of strings.
REG_EXPAND_SZ values are already expanded using the current environment variables.
REG_BINARY values are returned as AutoShell CharArr objects because JavaScript string variables cannot properly handle binary data.

If the specified key or the value does not exist, the function raises an exception.

Examples

Get value named "Number" from key HKLM\Software\ACME:

regGetVal("HKLM\\Software\\ACME", "Number");

Get value named "Label" from key HKLM\Software\ACME with error handling:

try {
    regGetVal("HKLM\\Software\\ACME", "Label");
    ? "Success"
}
catch(e) {
    ? "Failure:", e
}

Get value from remote machine client8:

regGetVal("client8::HKLM\\Software\\ACME", "Name");