Registry Provider::DeleteRegKey


Deletes a registry subkey and all its descendants, along with their values. Used by Microsoft® Provisioning Framework (MPF).

DeleteRegKey is a wrapper for the Microsoft® Win32® API function SHDeleteKey.

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

XML Output Schema

DeleteRegKey does not return data.

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 data.

Children:
regKey (minOccurs="1" maxOccurs="1")

machine Description:
Machine for the key to delete. The following sample code illustrates the use of machine.
<machine>
  <name>BOB1</name>
</machine> 

Parent:
regKey

Child:
name (minOccurs="1" maxOccurs="1")

name Description:
Name of the machine, root key, or subkey to delete.

Parents:
machine, rootkey, subkey

regKey Description:
Encapsulates information about the registry key to delete. The following sample code illustrates the use of regKey.
<regKey>
  <machine>
	<name>BOB1</name>
  </machine>
  <rootkey>
	<name>HKEY_LOCAL_MACHINE</name>
  </rootkey>
  <subkey>
	<name>SOFTWARE\Microsoft\Active Setup\TestCreateKey</name>
  </subkey>
</regKey>

Parent:
executeData

Children:
machine (minOccurs="1" maxOccurs="1")
rootkey (minOccurs="1" maxOccurs="1")
subkey (minOccurs="1" maxOccurs="1")

rootkey Description:
Root key to delete. The following sample code illustrates the use of rootkey.
<rootkey>
  <name>HKEY_LOCAL_MACHINE</name>
</rootkey>

Parent:
regKey

Child:
name (minOccurs="1" maxOccurs="1")

subkey Description:
Subkey to delete. The following sample code illustrates the use of subkey.
<subkey>
  <name>SOFTWARE\Microsoft\Active Setup</name>
</subkey> 

Parent:
regKey

Child:
name (minOccurs="1" maxOccurs="1")

See Also

DeleteRegValue, Registry Provider


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