ClusterEnum 関数 (clusapi.h)

クラスター内の クラスター オブジェクト を列挙し、呼び出しごとに 1 つのオブジェクトの名前を返 しますPCLUSAPI_CLUSTER_ENUM型は、この関数へのポインターを定義します。

構文

DWORD ClusterEnum(
  [in]      HCLUSENUM hEnum,
  [in]      DWORD     dwIndex,
  [out]     LPDWORD   lpdwType,
  [out]     LPWSTR    lpszName,
  [in, out] LPDWORD   lpcchName
);

パラメーター

[in] hEnum

ClusterOpenEnum 関数によって返されるクラスター列挙ハンドル。

[in] dwIndex

列挙する次のエントリを識別するために使用されるインデックス。 このパラメーターは 、ClusterEnum の最初の呼び出しでは 0 にし、その後の呼び出しではインクリメントする必要があります。

[out] lpdwType

返されるオブジェクトの型へのポインター。 呼び出しごとに 、CLUSTER_ENUM 列挙の次のいずれかの値が返されます。

CLUSTER_ENUM_NODE (1 (0x1))

クラスター内の ノード を列挙します。

CLUSTER_ENUM_RESTYPE (2 (0x2))

クラスター内の リソースの種類 を列挙します。

CLUSTER_ENUM_RESOURCE (4 (0x4))

クラスター内の リソース を列挙します。

CLUSTER_ENUM_GROUP (8 (0x8))

クラスター内の グループ を列挙します。

CLUSTER_ENUM_NETWORK (16 (0x10))

クラスター内の ネットワーク を列挙します。

CLUSTER_ENUM_NETINTERFACE (32 (0x20))

クラスター内の ネットワーク インターフェイス を列挙します。

CLUSTER_ENUM_SHARED_VOLUME_RESOURCE (1073741824 (0x40000000))

クラスターによって使用されるクラスター共有ボリュームを列挙します。

メモ 他のほとんどの列挙ビットマスクとは異なり、この値は単独で使用する必要があります。 OR 演算子を使用して他のビットマスクと組み合わせないでください。
 
Windows Server 2008: CLUSTER_ENUM_SHARED_VOLUME_RESOURCE値は、Windows Server 2008 R2 より前はサポートされていません。

CLUSTER_ENUM_INTERNAL_NETWORK (2147483648 (0x80000000))

クラスターが内部通信に使用するネットワークを列挙します。 ネットワークは 、SetClusterNetworkPriorityOrder 関数によって確立された優先順位が最も高い順に列挙されます。

メモ 他のほとんどの列挙ビットマスクとは異なり、この値は単独で使用する必要があります。 OR 演算子を使用して他のビットマスクと組み合わせないでください。
 

CLUSTER_ENUM_ALL ((CLUSTER_ENUM_NODE |CLUSTER_ENUM_RESTYPE |CLUSTER_ENUM_RESOURCE |CLUSTER_ENUM_GROUP |CLUSTER_ENUM_NETWORK |CLUSTER_ENUM_NETINTERFACE))

すべての クラスター オブジェクトを列挙します。

[out] lpszName

返されたオブジェクトの名前を含む null で終わる Unicode 文字列へのポインター。

[in, out] lpcchName

文字数としての lpszName バッファーのサイズへのポインター。 入力時に、バッファーが保持できる最大文字数 (終端 の NULL を含む) を指定します。 出力時に、終了 NULL を除く、結果の名前の文字数を指定します。

戻り値

この関数は、次のいずれかの値を返します。

リターン コード/値 説明
ERROR_SUCCESS
0
操作は正常に完了しました。
ERROR_NO_MORE_ITEMS
259 (0x103)
データはこれ以上ありません。 この値は、要求された型のオブジェクトが返されない場合に返されます。
ERROR_MORE_DATA
234 (0xEA)
詳細なデータを入手できます。 lpszName が指すバッファーが、結果を保持するのに十分な大きさでない場合、この値が返されます。 lpcchName パラメーターは、終了 NULL を除く、結果内の文字数を返します。

注釈

ClusterEnum 関数は、通常、1 つ以上の種類のクラスター オブジェクトのコレクションを反復処理するために使用されます。 たとえば、アプリケーションがクラスター内のすべての ノード を列挙する場合は、 ClusterOpenEnum を呼び出して、ノードを処理できるクラスター列挙子を開きます。 dwType パラメーターをCLUSTER_ENUM_NODEに設定して、列挙するオブジェクトの種類としてノードを指定します。 アプリケーションがノードに加えて グループ を列挙する場合、 dwType パラメーターは CLUSTER_ENUM_NODE | CLUSTER_ENUM_GROUP. ClusterOpenEnum が返すハンドルを使用して、アプリケーションは ClusterEnum を繰り返し呼び出して各オブジェクトを取得します。 lpdwType パラメーターは、取得されるオブジェクトの型を指します。

lpcchName はバイト数ではなく文字数を参照し、返されるサイズにはカウントに終端 NULL が含まれていないことに注意してください。 バッファーのサイズ設定の詳細については、「 データ サイズ規則」を参照してください。

オブジェクトの列挙を参照してください。

要件

   
サポートされている最小のクライアント サポートなし
サポートされている最小のサーバー Windows Server 2008 Enterprise、Windows Server 2008 Datacenter
対象プラットフォーム Windows
ヘッダー clusapi.h
Library ClusAPI.lib
[DLL] ClusAPI.dll

こちらもご覧ください

ClusterCloseEnum

ClusterOpenEnum

SetClusterNetworkPriorityOrder