ClusterEnum 関数 (clusapi.h)

[アーティクル]
08/22/2023

クラスター内のクラスターオブジェクトを列挙し、呼び出しごとに 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 関数によって確立された優先順位が最も高い順に列挙されます。

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 を除く、結果の名前の文字数を指定 します。

戻り値

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

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