Get Registry Entry Value (DriveWorks Documentation)

Get Registry Entry Value

Retrieves a registry entry value from the local machine running DriveWorks.

Properties

Property Name	Description
Title	Changes the Title (not the name) of the task.
Root	The Root of the registry, registry roots can be one of five options (ClassesRoot, CurrentConfig CurrentUser, LocalMachine, Users).
Key Path	The subsequent path following the registry root. If left blank the task will attempt to find the entry within the root.
Name	The entry name to retrieve from.

Root, Key Path and Name are non-case sensitive.

Example

For the entity with the name "sCurrency" within the path:

HKEY_CURRENT_USER\Control Panel\International

Property Name	Example Rule	Example Result	Meaning
Root	"CurrentUser"	HKEY_CURRENT_USER	This will find the corresponding registry root and use the "HKEY" variant.
Key Path	"Control Panel\International"	Control Panel\International	The rest of the path minus the "HKEY" root.
Name	"sCurrency"	sCurrency	Will find and retrieve the value of this entry within the specified path.
Value	(Return Node)	"£"	The value that is retrieved.

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

Data Output

Output Name	Description
Value	The value of the entry.

Output Types

Values returned from this task will take different forms dependent on its data-type.

Type Name	Type Description	Type Returned
REG_SZ (string)	String	String
REG_DWORD (Dword)	32-bit number (maximum of 4,294,967,295)	Number
REG_QWORD (Qword)	64-bit number (maximum of 2^64)	Number
REG_EXPANDED_SZ (ExpandString)	An expanded string. A string that can use Environment Variables	String
REG_MULTI_SZ (MultiString)	An array of strings	Array of strings
REG_BINARY (Binary)	Binary data	Array of hexadecimal values
REG_NONE (None)	No value defined	An Empty String ("")

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

The status output navigation is as follows:

Success

Successfully retrieved value with name *entry name*, *root*, *key path* and *data-type*

Success with Warnings

N/A - should never be fulfilled.

Failed (one of the following occurred)

The property "Root" cannot be left empty.
The property "Name" cannot be left empty.
*Root* is not a valid root. Valid roots are: ‘ClassesRoot’, ‘CurrentConfig’, ‘CurrentUser’, ‘LocalMachine’, ’Users’.
Could not find the key path *key path* with root *root*.
Failed to retrieve entry with name *name*, *root* and key path *key path*.
Unsupported data *data-type* for entry with name *name*, *root* and key-path *key path*.

Useful Resources

Microsoft Article - Windows registry information for advanced users

Microsoft Article - Predefined Keys

Microsoft Article - Registry Value Types

DriveWorks Pro 22 Get Registry Entry Value