Win32 API 日本語リファレンス
ホーム › Networking.Clustering › PCLUSAPI_CLUSTER_GROUP_ENUM

PCLUSAPI_CLUSTER_GROUP_ENUM

コールバック

シグネチャ

DWORD PCLUSAPI_CLUSTER_GROUP_ENUM(
    HGROUPENUM hGroupEnum,
    DWORD dwIndex,
    DWORD* lpdwType,
    LPWSTR lpszResourceName,
    DWORD* lpcchName
);

パラメーター

フィールド型説明
hGroupEnumHGROUPENUMClusterGroupOpenEnum 関数が返したグループ列挙ハンドルです。
dwIndexDWORD返されるリソースまたはノードのインデックスです。このパラメーターは、ClusterGroupEnum の最初の呼び出しではゼロを指定し、以降の呼び出しでは 1 ずつ増やします。
lpdwTypeDWORD*

ClusterGroupEnum が返すオブジェクトの種類へのポインターです。CLUSTER_GROUP_ENUM 列挙型の有効な値は次のとおりです。

CLUSTER_GROUP_ENUM_CONTAINS (1)

オブジェクトは、グループ内のリソースの 1 つです。

CLUSTER_GROUP_ENUM_NODES (2)

オブジェクトは、グループの優先所有者一覧に含まれるノードの 1 つです。

lpszResourceNameLPWSTR返されたリソースまたはノードの名前を格納する、null で終わる Unicode 文字列へのポインターです。
lpcchNameDWORD*lpszResourceName バッファーのサイズを文字数で表した値へのポインターです。入力時には、終端の NULL を含めてバッファーが保持できる最大文字数を指定します。出力時には、終端の NULL を除いた、結果として得られる名前の文字数が格納されます。

公式ドキュメント

グループ内のリソース、またはグループの優先所有者であるノードを列挙し、呼び出しごとにリソースまたはノードの名前を返します。PCLUSAPI_CLUSTER_GROUP_ENUM 型は、この関数へのポインターを定義します。

戻り値

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

リターンコード/値 説明
ERROR_SUCCESS
0
 操作は正常に完了しました。
ERROR_MORE_DATA
234 (0xEA)
 さらにデータがあります。この値は、lpszResourceName が指すバッファーが結果を格納するのに十分な大きさでない場合に返されます。lpcchName パラメーターには、終端の NULL を除いた結果の文字数が返されます。
ERROR_NO_MORE_ITEMS
259 (0x103)
 これ以上のデータはありません。この値は、返すべきリソースまたはノードがこれ以上ない場合に返されます。

ERROR_NO_MORE_ITEMS または ERROR_MORE_DATA の値で説明されている以外の問題によって操作が失敗した場合、ClusterGroupEnum は システムエラーコードを返します。

解説(Remarks)

lpcchName はバイト数ではなく文字数を表すこと、および返されるサイズには終端の NULL が含まれないことに注意してください。バッファーのサイズ指定について詳しくは、Data Size Conventions を参照してください。

ClusterGroupEnum は、リソース DLL のどのエントリポイント関数からも呼び出さないでください。ClusterGroupEnum は、ワーカースレッドからであれば安全に呼び出せます。詳しくは、Function Calls to Avoid in Resource DLLs を参照してください。

例

Enumerating Objects を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)