OpenClusterEx 関数 (clusapi.h)

クラスターへの接続を開き、それに対するハンドルを返します。

構文

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

パラメーター

[in, optional] lpszClusterName

次のいずれかの値を指定します。

• クラスターの名前、または NetBIOS 名、完全修飾 DNS 名、または IP アドレスとして表されるクラスター ノード の 1 つを含む null で終わる Unicode 文字列へのポインター。 これにより、RPC クラスター ハンドルが生成されます。
• NULL。ローカル コンピューターが属するクラスターへの LPC ハンドルを生成します。

[in] DesiredAccess

要求されたアクセス特権。 これは、 GENERIC_READ (0x80000000 )、GENERIC_ALL ( 0x10000000 )、または MAXIMUM_ALLOWED (0x02000000) の任意の組み合わせです。 この値が 0 (0) で、未定義のエラーが返される可能性があります。 GENERIC_ALLの使用は、OpenCluster の呼び出しと同じです。

[out, optional] GrantedAccess

付与されたアクセス権を受け取る DWORD のアドレスを含む省略可能なパラメーター。 DesiredAccess パラメーターがMAXIMUM_ALLOWED (0x02000000) の場合、このパラメーターが指す DWORD には、このユーザーに付与される最大特権が含まれます。

戻り値

操作が成功した場合、 OpenClusterEx は クラスター ハンドルを返します。

リターン コード/値	Description
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