ClusterGroupEnum 関数 (clusapi.h)
グループ内の リソース 、または グループ の優先所有者である ノード を列挙し、各呼び出しでリソースまたはノードの名前を返します。 PCLUSAPI_CLUSTER_GROUP_ENUM型は、この関数へのポインターを定義します。
構文
DWORD ClusterGroupEnum(
[in] HGROUPENUM hGroupEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszResourceName,
[in, out] LPDWORD lpcchName
);
パラメーター
[in] hGroupEnum
ClusterGroupOpenEnum 関数によって返されるグループ列挙ハンドル。
[in] dwIndex
返すリソースまたはノードのインデックス。 このパラメーターは、 ClusterGroupEnum の最初の呼び出しでは 0 にし、その後の呼び出しではインクリメントする必要があります。
[out] lpdwType
ClusterGroupEnum によって返されるオブジェクトの型へのポインター。 CLUSTER_GROUP_ENUM列挙体の有効な値を次に示します。
CLUSTER_GROUP_ENUM_CONTAINS (1)
オブジェクトは、グループ内のリソースの 1 つです。
CLUSTER_GROUP_ENUM_NODES (2)
オブジェクトは、グループの優先所有者リスト内のノードの 1 つです。
[out] lpszResourceName
返されるリソースまたはノードの名前を含む null で終わる Unicode 文字列へのポインター。
[in, out] lpcchName
lpszResourceName バッファーのサイズを文字数として指すポインター。 入力時に、バッファーが保持できる最大文字数 (終端の NULL を含む) を指定 します。 出力時に、終了する NULL を除く、結果の名前の文字数を指定 します。
戻り値
関数は、次のいずれかの値を返すことができます。
| リターン コード/値 | Description |
|---|---|
|
操作は正常に完了しました。 |
|
詳細なデータを入手できます。 lpszResourceName が指すバッファーが、結果を保持するのに十分な大きさではない場合、この値が返されます。 lpcchName パラメーターは、終了する NULL を除き、結果の文字数を返します。 |
|
データはこれ以上ありません。 この値は、返されるリソースまたはノードがなくなった場合に返されます。 |
ERROR_NO_MORE_ITEMS値またはERROR_MORE_DATA値で説明されている問題以外の問題が原因で操作が成功しなかった場合、ClusterGroupEnum はシステム エラー コードを返します。
注釈
lpcchName はバイト数ではなく文字数を参照し、返されるサイズにはカウントに終端の NULL が含まれていないことに注意してください。 バッファーのサイズ設定の詳細については、「 データ サイズ規則」を参照してください。
リソース DLL エントリ ポイント関数から ClusterGroupEnum を呼び出さないでください。 ClusterGroupEnum は、ワーカー スレッドから安全に呼び出すことができます。 詳細については、「 リソース DLL での回避する関数呼び出し」を参照してください。
例
「 オブジェクトの列挙」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows Server 2008 Enterprise、Windows Server 2008 Datacenter |
| 対象プラットフォーム | Windows |
| ヘッダー | clusapi.h |
| Library | ClusAPI.lib |
| [DLL] | ClusAPI.dll |