OpenClusterEx 函数 (clusapi.h)

打开与群集的连接,并返回该 群集 的句柄。

语法

HCLUSTER OpenClusterEx(
  [in, optional]  LPCWSTR lpszClusterName,
  [in]            DWORD   DesiredAccess,
  [out, optional] DWORD   *GrantedAccess
);

参数

[in, optional] lpszClusterName

指定以下值之一:

  • 指向以 null 结尾的 Unicode 字符串的指针,该字符串包含群集的名称或表示为 NetBIOS 名称、完全限定的 DNS 名称或 IP 地址的群集 节点 之一。 这会生成 RPC 群集句柄。
  • NULL,生成本地计算机所属群集的 LPC 句柄。

[in] DesiredAccess

请求的访问权限。 这可以是 GENERIC_READ (0x80000000) GENERIC_ALL (0x10000000) MAXIMUM_ALLOWED (0x02000000) 的任意组合。 如果此值为零 (0) 可能会返回未定义的错误。 使用 GENERIC_ALL 与调用 OpenCluster 相同。

[out, optional] GrantedAccess

可选参数,其中包含将接收授予的访问权限的 DWORD 的地址。 如果 DesiredAccess 参数 MAXIMUM_ALLOWED (0x02000000) 则此参数指向的 DWORD 将包含授予此用户的最大特权。

返回值

如果操作成功, OpenClusterEx 将返回群集句柄。

返回代码/值 说明
NULL
0
操作未成功。 有关错误的详细信息,请调用 GetLastError 函数。 如果目标服务器不支持 OpenClusterEx 函数 (例如,如果目标服务器运行 Windows Server 2008 或更早版本) 则 GetLastError 函数将返回 RPC_S_PROCNUM_OUT_OF_RANGE (1745) 。

注解

群集句柄是指向内部定义的结构的指针,该结构存储有关与群集的 RPC 或 LPC 连接的信息。 从群集句柄获取的任何对象句柄都将与存储在群集结构中的 RPC 或 LPC 会话数据相关联。 组合 RPC 和 LPC 句柄或使用从不同上下文获取的句柄可能会导致异常或其他不可预知的结果。 有关详细信息,请参阅 LPC 和 RPC 句柄

完成群集句柄后,请务必调用 CloseCluster ,以确保释放所有内存并完全关闭连接。

要求

要求
最低受支持的客户端 无受支持的版本
最低受支持的服务器 Windows Server 2008 R2 Datacenter、Windows Server 2008 R2 Enterprise
目标平台 Windows
标头 clusapi.h
Library ClusAPI.lib
DLL ClusAPI.dll