Share via

3.1.4.6 DeleteKey (Opnum 4)

  • Article

The DeleteKey method deletes a node and all its data from the metabase. All of the subnodes are recursively deleted.

 HRESULT DeleteKey(
   [in] METADATA_HANDLE hMDHandle,
   [unique, in, string] LPCWSTR pszMDPath
 );

hMDHandle: An unsigned 32-bit integer value containing an open metabase handle specifying a node in the metabase where the key is to be deleted.

pszMDPath: A pointer to a Unicode string that contains the path of the node to be deleted, relative to the path of the hMDHandle parameter. This parameter MUST NOT be NULL.

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.

0x80070003

ERROR_PATH_NOT_FOUND

The system cannot find the path specified.

0x80070005

E_ACCESSDENIED

General access denied error.

0x80070006

ERROR_INVALID_HANDLE

The handle is invalid.

0x80070057

E_INVALIDARG

One or more arguments are invalid.

The opnum field value for this method is 4.

When processing this call, the server MUST do the following:

  • Check the handle parameter. This handle is valid if it is a handle returned from a previous OpenKey call. If the handle is invalid, return ERROR_INVALID_HANDLE error.

  • The server SHOULD check whether the handle was opened for write access. If not, return E_ACCESSDENIED.<6>

  • Check whether the relative path points to the existing subnode of parent handle. If not, return ERROR_PATH_NOT_FOUND.

  • Delete the node that contains the path which was calculated to be the path of the parent handle combined with the relative path.

  • Delete all child nodes of this node.