Share via


IMSAdminBase::DeleteKey

The IMSAdminBase::DeleteKey method deletes a key and all of its data from the metabase. All of the key's subkeys are recursively deleted.

HRESULT DeleteKey(
      METADATA_HANDLE hMDHandle,
      LPCWSTR pszMDPath
);

Parameters

  • hMDHandle
    Specifies a handle with write permission returned by the IMSAdminBase::OpenKey method. METADATA_MASTER_ROOT_HANDLE is not valid for this operation.

  • pszMDPath
    Points to a string that contains the path of the key to be deleted, relative to the path of hMDHandle. For example, if the handle references the /LM key, you could specify the Web services subkey be deleted by using the path /W3SVC.

    This parameter cannot be null.

Return Values

Returns an HRESULT that contains one of the following values:

Value

Description

E_ACCESSDENIED

Access is denied. Either the open handle does not have read or write permission as needed, or the user does not have sufficient permissions to perform the operation.

E_INVALIDARG

The parameter is incorrect.

HRESULT_FROM_WIN32(ERROR_PATH_NOT_FOUND)

The specified path is not found in the metabase.

S_OK

The method succeeded.

Requirements

Client: Requires Windows XP Professional, Windows 2000 Professional, or Windows NT Workstation 4.0.

Server: Requires Windows Server 2003, Windows 2000 Server, or Windows NT Server 4.0.

Product: IIS

Header: Declared in iadmw.h; include iiscnfg.h.