Edit

Share via

ClusterRegOpenKey function (clusapi.h)

  • Article

Opens an existing cluster database key.

Syntax

LONG ClusterRegOpenKey(
  [in]  HKEY    hKey,
  [in]  LPCWSTR lpszSubKey,
  [in]  REGSAM  samDesired,
  [out] PHKEY   phkResult
);

Parameters

[in] hKey

Handle to a currently open key. This parameter cannot be NULL.

[in] lpszSubKey

Pointer to a null-terminated Unicode string specifying the name of the subkey to be created or opened. The lpszSubKey parameter must point to a subkey that:

  • Is a child key of the key identified by hKey.
  • Must not begin with the backslash character ( \ ).
  • Must not be NULL.
The lpszSubKey parameter can point to an empty string, causing ClusterRegCreateKey to return a handle to the database key represented by hKey.

[in] samDesired

Access mask that specifies the security access needed for the new key.

[out] phkResult

Pointer to a handle to the opened or created key.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

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

Remarks

Callers should call ClusterRegCloseKey to close the key handle opened by ClusterRegOpenKey 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

ClusterRegCreateKey