Registry Provider::GetRegValue

Retrieves the value for a specific registry item. Used by Microsoft Provisioning Framework (MPF).

GetRegValue is a wrapper for Microsoft Win32® function RegQueryValueEx.

The following table describes the XML elements and attributes. Unless otherwise indicated, the data type is string.

Element	Description, relationships, and attributes
executeData	Description: Encapsulates the procedure's input and output data. Children: regValue (minOccurs="1" maxOccurs="1", input only) regValueResp (minOccurs="1" maxOccurs="1", output only)
item	Description: Encapsulates item information. Parents: executeData (input), regValueResp (output) Children: name (minOccurs="1" maxOccurs="1", input and output) regType (minOccurs="1" maxOccurs="1", output only) values (minOccurs="0" maxOccurs="1", output only)
machine	Description: Machine to retrieve values for. The following sample code illustrates the use of machine. `<machine> <name>BOB1</name> </machine>` Parent: regValue Child: name (minOccurs="1" maxOccurs="1")
name	Description: Name of the item, machine, root key, or subkey for the value to retrieve. Parents: machine, rootkey, subkey
regType	Description: Code that indicates the type of data stored in the retrieved value. The following sample code illustrates the use of regType. `<regType>REG_DWORD</regType>` Parent: item
regValue	Description: Encapsulates information about the value to retrieve. The following sample code illustrates the use of regValue. `<regValue> <machine> <name>BOB1</name> </machine> <rootkey> <name>HKEY_LOCAL_MACHINE</name> </rootkey> <subkey> <name>SOFTWARE\Microsoft\Active Setup</name> </subkey> <item> <name>CompletionChar</name> <item> </regValue>` Parent: executeData Children: item (minOccurs="1" maxOccurs="1") machine (minOccurs="1" maxOccurs="1") rootkey (minOccurs="1" maxOccurs="1") subkey (minOccurs="1" maxOccurs="1")
regValueResp	Description: Returns the retrieved values. Parent: executeData Child: item (minOccurs="0" maxOccurs="1")
rootkey	Description: Root key to retrieve. The following sample code illustrates the use of rootkey. `<rootkey> <name>HKEY_LOCAL_MACHINE</name> </rootkey>` Parent: regValue Child: name (minOccurs="1" maxOccurs="1")
subkey	Description: Subkey to retrieve. The following sample code illustrates the use of subkey. `<subkey> <name>SOFTWARE\Microsoft\Active Setup</name> </subkey>` Parent: regValue Child: name (minOccurs="1" maxOccurs="1")
value	Description: Returned retrieved value for the registry item. Parent: values
values	Description: Encapsulates a list of returned retrieved values for the registry item. Parent: item Child: value (minOccurs="0" maxOccurs="*")

Remarks

Schema Definition

Input



<executeData>1..1
  <regValue>1..1
	<machine>1..1
	<name>1..1</name>
	</machine>
	<rootkey>1..1
	<name>1..1</name>
	</rootkey> 
	<subkey>1..1
	<name>1..1</name>
	</subkey>
	<item>1..1
	<name>1..1</name>
	</item>
  </regValue>
</executeData>

Output



<executeData>1..1
  <regValueResp>1..1
	<item>0..1
	<name>1..1</name>
	<regType>0..1</regType>
	<values>0..1
		<value>0..unbounded</value>
	</values> 
	</item>
  </regValueResp>
</executeData>

Sample Code

Applies To