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