ClusterNodeEnum 関数 (clusapi.h)
ノードにインストールされているネットワーク インターフェイスまたはグループを列挙し、各呼び出しでそれぞれの名前を返します。 PCLUSAPI_CLUSTER_NODE_ENUM型は、この関数へのポインターを定義します。
構文
DWORD ClusterNodeEnum(
[in] HNODEENUM hNodeEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName
);
パラメーター
[in] hNodeEnum
ClusterNodeOpenEnum 関数によって最初に返された既存の列挙オブジェクトを処理します。
[in] dwIndex
列挙する次のエントリを識別するために使用されるインデックス。 このパラメーターは、 ClusterNodeEnum への最初の呼び出しでは 0 にし、後続の呼び出しではインクリメントする必要があります。
[out] lpdwType
返されるオブジェクトの型へのポインター。 各呼び出しで 、CLUSTER_NODE_ENUM 列挙の次の値が返されます。
CLUSTER_NODE_ENUM_NETINTERFACES (1)
オブジェクトはネットワーク インターフェイスです。
CLUSTER_NODE_ENUM_GROUPS (0x00000002)
オブジェクトはクラスター グループです。
Windows Server 2008: CLUSTER_NODE_ENUM_GROUPS値は、Windows Server 2008 R2 より前はサポートされていません。
[out] lpszName
返されたオブジェクトの名前を含む null で終わる Unicode 文字列へのポインター。
[in, out] lpcchName
文字数としての lpszName バッファーのサイズへのポインター。 入力時に、バッファーが保持できる最大文字数 (終端の NULL を含む) を指定 します。 出力時に、終了する NULL を除く、結果の名前の文字数を指定します。
戻り値
関数は、次のいずれかの値を返します。
| リターン コード/値 | Description |
|---|---|
|
操作は正常に完了しました。 |
|
データはこれ以上ありません。 この値は、返される要求された型のオブジェクトがこれ以上ない場合に返されます。 |
|
詳細なデータを入手できます。 lpszName が指すバッファーが結果を保持するのに十分な大きさでない場合、この値が返されます。 lpcchName パラメーターは、終端の NULL を除き、結果の文字数を返します。 |
注釈
ClusterNodeEnum を使用するには、まず、dwType パラメーターを CLUSTER_NODE_ENUM_NETINTERFACES に設定して ClusterNodeOpenEnum を呼び出して、ノード列挙ハンドルを開きます。 詳細については、「 オブジェクトの列挙」を参照してください。
lpcchName パラメーターは、バイト数ではなく文字数を参照し、返されるサイズにはカウントに終端の NULL が含まれないことに注意してください。 バッファーのサイズ設定の詳細については、「 データ サイズ規則」を参照してください。
例
「 オブジェクトの列挙」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows Server 2008 Enterprise、Windows Server 2008 Datacenter |
| 対象プラットフォーム | Windows |
| ヘッダー | clusapi.h |
| Library | ClusAPI.lib |
| [DLL] | ClusAPI.dll |