3.1.4.9 DeleteAllData (Opnum 14)
The DeleteAllData method deletes all or a subset of local data associated with a particular node.
-
HRESULT DeleteAllData( [in] METADATA_HANDLE hMDHandle, [unique, in, string] LPCWSTR pszMDPath, [in] DWORD dwMDUserType, [in] DWORD dwMDDataType );
hMDHandle: An unsigned 32-bit integer value containing an open metabase handle specifying the node in the metabase where the key data is to be deleted.
pszMDPath: A pointer to a Unicode string that contains the path of the node with which the data to be deleted is associated, relative to the path of the hMDHandle parameter.
dwMDUserType: An integer value specifying the data to delete based on user type.
-
Value
Meaning
ALL_METADATA
0x00000000
Specifies all data, regardless of type.
ASP_MD_UT_APP
0x00000065
Specifies data specific to ASP application configuration.
IIS_MD_UT_FILE
0x00000002
Specifies data specific to a file, such as access permissions or logon methods.
IIS_MD_UT_SERVER
0x00000001
Specifies data specific to the server, such as ports in use and IP addresses.
IIS_MD_UT_WAM
0x00000064
Specifies data specific to WAM.
dwMDDataType: An integer value specifying a data type. If this parameter is not set to ALL_METADATA, the data item will be removed only if its data type matches the specified type.
-
Value
Meaning
ALL_METADATA
0x00000000
Specifies all data, regardless of type.
BINARY_METADATA
0x00000003
Specifies binary data in any form.
DWORD_METADATA
0x00000001
Specifies all DWORD (unsigned 32-bit integer) data.
EXPANDSZ_METADATA
0x00000004
Specifies all data consisting of a string that includes the terminating null character, which contains unexpanded environment variables.
MULTISZ_METADATA
0x00000005
Specifies all data represented as an array of strings, where each string contains two occurrences of the terminating null character.
STRING_METADATA
0x00000002
Specifies all data consisting of an ASCII string that includes the terminating null character.
Return Values: A signed 32-bit value that indicates return status. If the method returns a negative value, it failed. If the 12-bit facility code (bits 16–27) is set to 0x007, the value contains a Win32 error code in the lower 16 bits. Zero or positive values indicate success, with the lower 16 bits in positive nonzero values containing warnings or flags defined in the method implementation. For more information about Win32 error codes and HRESULT values, see [MS-ERREF].
-
Return value/code
Description
0x00000000
S_OK
The call was successful.
0x80070005
E_ACCESSDENIED
General access denied error.
0x80070006
ERROR_INVALID_HANDLE
The handle is invalid.
The opnum field value for this method is 14.
When processing this call, the server MUST do the following:
Check the handle. This handle is valid if it is either the master root handle or a handle returned from a previous OpenKey call. If the handle is invalid, return ERROR_INVALID_HANDLE.
The server SHOULD check whether the handle was opened for write access. If not, return E_ACCESSDENIED.<9>
Check whether the relative path points to the existing subnode of the parent handle. If not, return an error.
For each data value that is defined on the destination node and not inherited from the parent node, repeat the following:
If the dwMDUserType and dwMDDataType parameters are equal to "ALL_METADATA", delete the data.
If the user type parameter equals the user type of the data and the data type parameter is equal to the data type of the data or ALL_METADATA, delete this data value.
If the data type parameter equals the data type of the data and the user type parameter is equal to the user type of the data or ALL_METADATA, the server SHOULD delete this data value.<10>