ClusterResourceEnum 関数 (clusapi.h)
リソースの依存 リソース 、 ノード、またはその両方を列挙します。 呼び出しごとに 1 つの クラスター オブジェクト の名前を返します。 PCLUSAPI_CLUSTER_RESOURCE_ENUM型は、この関数へのポインターを定義します。
構文
DWORD ClusterResourceEnum(
[in] HRESENUM hResEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName
);
パラメーター
[in] hResEnum
ClusterResourceOpenEnum 関数から返されるリソース列挙ハンドル。
[in] dwIndex
返すリソースまたはノード オブジェクトのインデックス。 このパラメーターは、 ClusterResourceEnum 関数の最初の呼び出しでは 0 で、その後の呼び出しではインクリメントする必要があります。
[out] lpdwType
ClusterResourceEnum によって返されるオブジェクトの型。
使用できる値は、次の CLUSTER_RESOURCE_ENUM 列挙値のいずれかです。
CLUSTER_RESOURCE_ENUM_DEPENDS (1)
オブジェクトはリソースであり、 hResEnum はこのオブジェクトに依存するリソースです。
CLUSTER_RESOURCE_ENUM_PROVIDES (2)
オブジェクトは、 hResEnum によって識別されるリソースに依存するリソースです。
CLUSTER_RESOURCE_ENUM_NODES (4)
オブジェクトは、 hResEnum によって識別されるリソースをホストできるノードです。
[out] lpszName
返されるオブジェクトの名前を含む null で終わる Unicode 文字列へのポインター。
[in, out] lpcchName
lpszName バッファーのサイズを文字数として指すポインター。 入力時に、バッファーが保持できる最大文字数 (終端の null 文字を含む) を指定します。 出力時に、結果の名前の文字数を指定します。終端の null 文字は除きます。
戻り値
関数は、次のいずれかの値を返します。
| リターン コード/値 | Description |
|---|---|
|
操作が正常に完了したか、 lpszName パラメーターが NULL です。 |
|
lpszName パラメーターが指すバッファーは、結果を保持するのに十分な大きさではありません。 lpcchName パラメーターは、終了する null 文字を除き、結果の文字数を返します。 |
|
返されるオブジェクトはこれ以上ありません。 |
| 返されたその他のエラー コードは、操作が失敗したことを示します。 |
注釈
lpcchName はバイト数ではなく文字数を参照し、返されるサイズにはカウントに終端の null 文字が含まれていないことに注意してください。 バッファーのサイズ設定の詳細については、「 データ サイズ規則」を参照してください。
リソース DLL エントリ ポイント関数から ClusterResourceEnum を呼び出さないでください。 ClusterResourceEnum は、ワーカー スレッドから安全に呼び出すことができます。 詳細については、「 リソース DLL での回避する関数呼び出し」を参照してください。
例
「 オブジェクトの列挙」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows Server 2008 Enterprise、Windows Server 2008 Datacenter |
| 対象プラットフォーム | Windows |
| ヘッダー | clusapi.h |
| Library | ClusAPI.lib |
| [DLL] | ClusAPI.dll |