ClusterResourceTypeEnum 関数 (clusapi.h)

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

リソースの種類の所有者ノードまたはリソースを列挙し、呼び出しごとに 1 つのノードまたはリソースの名前を返します。 PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM型は、この関数へのポインターを定義します。

構文

DWORD ClusterResourceTypeEnum(
  [in]      HRESTYPEENUM hResTypeEnum,
  [in]      DWORD        dwIndex,
  [out]     LPDWORD      lpdwType,
  [out]     LPWSTR       lpszName,
  [in, out] LPDWORD      lpcchName
);

パラメーター

[in] hResTypeEnum

ClusterResourceTypeOpenEnum から返されるリソースの種類の列挙ハンドル。

[in] dwIndex

返すリソースまたはノードオブジェクトのインデックス。このパラメーターは、 ClusterResourceTypeEnum への最初の呼び出しでは 0 にし、その後の呼び出しではインクリメントする必要があります。

[out] lpdwType

ClusterResourceTypeEnum によって返されるオブジェクトの型。 CLUSTER_RESOURCE_TYPE_ENUM列挙体の次の値が有効です。

CLUSTER_RESOURCE_TYPE_ENUM_NODES (1)

オブジェクトは、リソースの種類の所有者として使用可能なノードです。

CLUSTER_RESOURCE_TYPE_ENUM_RESOURCES (2)

オブジェクトは、リソースの種類のインスタンスであるリソースです。

[out] lpszName

返されたオブジェクトの名前を含む null で終わる Unicode 文字列へのポインター。

[in, out] lpcchName

文字数としての lpszName バッファーのサイズへのポインター。入力時に、バッファーが保持できる最大文字数 (終端の NULL を含む) を指定 します。出力時に、終了する NULL を除く、結果の名前の文字数を指定します。

戻り値

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

リターンコード/値	Description
ERROR_SUCCESS 0	操作に成功しました。
ERROR_NO_MORE_ITEMS 259	返されるオブジェクトはこれ以上ありません。
ERROR_MORE_DATA 234	lpszName が指すバッファーは、結果を保持するのに十分な大きさではありません。 lpcchName パラメーターは、終端の NULL を除き、結果の文字数を返します。
システムエラーコード	操作が失敗しました。

注釈

lpcchName はバイト数ではなく文字数を参照し、返されるサイズにはカウントに終端の NULL が含まれていないことに注意してください。バッファーのサイズ設定の詳細については、「データサイズ規則」を参照してください。

例

「オブジェクトの列挙」を参照してください。

要件

要件	値
サポートされている最小のクライアント	サポートなし
サポートされている最小のサーバー	Windows Server 2008 Enterprise、Windows Server 2008 Datacenter
対象プラットフォーム	Windows
ヘッダー	clusapi.h
Library	ClusAPI.lib
[DLL]	ClusAPI.dll