Reads a value from the registry.

Value := RegRead(KeyName, ValueName, Default)



Type: String

The full name of the registry key.

This must start with HKEY_LOCAL_MACHINE, HKEY_USERS, HKEY_CURRENT_USER, HKEY_CLASSES_ROOT, or HKEY_CURRENT_CONFIG (or the abbreviations for each of these, such as HKLM). To access a remote registry, prepend the computer name and a slash, as in this example: \\workstation01\HKEY_LOCAL_MACHINE

KeyName can be omitted only if a registry loop is running, in which case it defaults to the key of the current loop item. If the item is a subkey, the full name of that subkey is used by default. If the item is a value, ValueName defaults to the name of that value, but can be overridden.


Type: String

The name of the value to retrieve. If blank or omitted, the key's default value will be retrieved (except as noted above). The default value is displayed as "(Default)" by RegEdit. If there is no default value (that is, if RegEdit displays "value not set"), an OSError is thrown.


Type: Any

The value to return if the specified key or value does not exist. If omitted, an OSError is thrown instead of returning a default value.

Return Value

Type: String or Integer

This function returns a value of the specified registry key.

Error Handling

An OSError is thrown if there was a problem, such as a nonexistent key or value when Default is omitted, or a permission error.

A_LastError is set to the result of the operating system's GetLastError() function.


Currently only the following value types are supported: REG_SZ, REG_EXPAND_SZ, REG_MULTI_SZ, REG_DWORD, and REG_BINARY.

REG_DWORD values are always expressed as positive decimal numbers. If the number was intended to be negative, convert it to a signed 32-bit integer by using OutputVar := OutputVar << 32 >> 32 or similar.

When reading a REG_BINARY key the result is a string of hex characters. For example, the REG_BINARY value of 01,a9,ff,77 will be read as the string 01A9FF77.

When reading a REG_MULTI_SZ key, each of the components ends in a linefeed character (`n). If there are no components, an empty string is returned. See FileSelect for an example of how to extract the individual components from the return value.

To retrieve and operate upon multiple registry keys or values, consider using a registry-loop.

For details about how to access the registry of a remote computer, see the remarks in registry-loop.

To read and write entries from the 64-bit sections of the registry in a 32-bit script or vice versa, use SetRegView.

RegCreateKey, RegDelete, RegDeleteKey, RegWrite, Registry-loop, SetRegView, IniRead


Reads a value from the registry and store it in TestValue.

TestValue := RegRead("HKEY_LOCAL_MACHINE\Software\SomeApplication", "TestValue")

Retrieves and reports the path of the "Program Files" directory. See EnvGet example #2 for an alternative method.

; The line below ensures that the path of the 64-bit Program Files
; directory is returned if the OS is 64-bit and the script is not.
SetRegView 64

ProgramFilesDir := RegRead("HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion", "ProgramFilesDir")
MsgBox "Program files are in: " ProgramFilesDir

Retrieves the TYPE of a registry value (e.g. REG_SZ or REG_DWORD).

MsgBox RegKeyType("HKCU", "Environment", "TEMP")

RegKeyType(RootKey, SubKey, ValueName)  ; This function returns the type of the specified value.
    Loop Reg, RootKey "\" SubKey
        if (A_LoopRegName = ValueName)
            return A_LoopRegType
    return "Error"