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

PCLUSAPI_CLUSTER_RESOURCE_ENUM

コールバック

シグネチャ

DWORD PCLUSAPI_CLUSTER_RESOURCE_ENUM(
    HRESENUM hResEnum,
    DWORD dwIndex,
    DWORD* lpdwType,
    LPWSTR lpszName,
    DWORD* lpcchName
);

パラメーター

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

ClusterResourceEnum が返すオブジェクトの種類です。

指定できる値は、次の CLUSTER_RESOURCE_ENUM 列挙値のいずれかです。

CLUSTER_RESOURCE_ENUM_DEPENDS (1)

オブジェクトはリソースであり、hResEnum はこのオブジェクトに依存するリソースです。

CLUSTER_RESOURCE_ENUM_PROVIDES (2)

オブジェクトは、hResEnum で識別されるリソースが依存しているリソースです。

CLUSTER_RESOURCE_ENUM_NODES (4)

オブジェクトは、hResEnum で識別されるリソースをホストできるノードです。

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

公式ドキュメント

リソースの依存リソース、 ノード、またはその両方を列挙します。1 回の呼び出しにつき 1 つの クラスターオブジェクトの名前を返します。PCLUSAPI_CLUSTER_RESOURCE_ENUM 型は、この関数へのポインターを定義します。

戻り値

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

戻り値/値 説明
ERROR_SUCCESS
0
 操作は正常に完了したか、lpszName パラメーターが NULL です。
ERROR_MORE_DATA
234 (0xEA)
 lpszName パラメーターが指すバッファーが、結果を格納するには小さすぎます。 lpcchName パラメーターには、終端の null 文字を除いた結果の文字数が返されます。
ERROR_NO_MORE_ITEMS
259 (0x103)
 返すオブジェクトがこれ以上ありません。
システムエラーコード
 上記以外のエラーコードが返された場合は、操作が失敗したことを示します。

解説(Remarks)

lpcchName はバイト数ではなく文字数を表し、返されるサイズには終端の null 文字が 含まれない点に注意してください。バッファーのサイズ設定の詳細については、 Data Size Conventions を参照してください。

ClusterResourceEnum は、リソース DLL のエントリポイント関数から呼び出さないでください。 ClusterResourceEnum はワーカースレッドからであれば安全に呼び出せます。詳細については、 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)