Registry Provider::EnumRegValue

Enumerates the values beneath a specified registry key. Used by Microsoft® Provisioning Framework (MPF).

EnumRegValue is a wrapper for Microsoft® Win32® API function RegEnumValue.

XML Input Schema

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

<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>
  </regValue>
</executeData>

XML Output Schema

The following code fragment shows the format for data this procedure returns. For more information on individual elements and attributes, see the Elements and Attributes table.

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

Elements and Attributes

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:
regValueResp

Children:
 name (minOccurs="1" maxOccurs="1", input and output)
regType (minOccurs="1" maxOccurs="1", output only)
values (minOccurs="0" maxOccurs="1", output only)
items Description:
 Encapsulates output of enumerated items.

Parent:
regValueResp

Child:
 item (minOccurs="0" maxOccurs="*")
machine Description:
 Machine to enumerate 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 machine, root key, or subkey for the key to enumerate the values of and the name of the values returned.

Parents:
item, machine, rootkey, subkey

regType Description:
 Code that indicates the type of data stored in the enumerated value. The following sample code illustrates the use of regType. 
<regType>REG_DWORD</regType>

Parent:
item

regValue Description:
 Encapsulates information about the key to enumerate. 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>
</regValue>

Parent:
executeData

Children:
 machine (minOccurs="1" maxOccurs="1")
rootkey (minOccurs="1" maxOccurs="1")
subkey (minOccurs="1" maxOccurs="1")
regValueResp Description:
 Returns the enumerated values.

Parent:
executeData

Child:
items (minOccurs="0" maxOccurs="1")
rootkey Description:
 Root key to enumerate from. 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 enumerate from. 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 enumerated value for the registry item.

Parent:
item

values Description:
 Encapsulates a list of returned enumerated values for the registry item.

Parent:
 value

Child:
 value (minOccurs="0" maxOccurs="*")

See Also

Registry Provider, EnumRegKey

Up Top of Page
© 1999-2002 Microsoft Corporation. All rights reserved.