ClusterRegDeleteKey function (clusapi.h)

  • Article

Deletes a cluster database key.

Syntax

LONG ClusterRegDeleteKey(
  [in] HKEY    hKey,
  [in] LPCWSTR lpszSubKey
);

Parameters

[in] hKey

Handle to a currently open key.

[in] lpszSubKey

Pointer to a null-terminated Unicode string specifying the name of the key to delete. The key pointed to by lpszSubKey cannot have subkeys; ClusterRegDeleteKey can only delete keys without subkeys. This parameter cannot be NULL.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS (0).

If the operation fails, the function returns a system error code.

Remarks

The ClusterRegDeleteKey function cannot delete a key that has one or more subkeys.

Do not call ClusterRegDeleteKey from the following resource DLL entry point functions:

ClusterRegDeleteKey can be safely called from any other resource DLL entry point function or from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform Windows
Header clusapi.h
Library ClusAPI.lib
DLL ClusAPI.dll

See also

ClusterRegCreateKey