GetClusterKey function (clusapi.h)

Opens the root of the cluster database subtree for a cluster.

Syntax

HKEY GetClusterKey(
  [in] HCLUSTER hCluster,
  [in] REGSAM   samDesired
);

Parameters

[in] hCluster

Handle to a cluster.

[in] samDesired

Access mask that describes the security access needed for the new key. For more information and possible values, see Registry Key Security and Access Rights.

Return value

If the operation succeeds, the function returns a database key handle for the cluster.

If the operation fails, the function returns NULL. For more information about the error, call GetLastError.

Remarks

The GetClusterKey function returns a handle to a cluster database key representing the cluster database subtree root for the cluster identified by hCluster. Callers should call ClusterRegCloseKey to close the key handle retrieved by GetClusterKey when they are done with it.

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

ClusterRegCloseKey

OpenCluster