PCLUSAPI_CLUSTER_NETWORK_ENUM
コールバックシグネチャ
DWORD PCLUSAPI_CLUSTER_NETWORK_ENUM(
HNETWORKENUM hNetworkEnum,
DWORD dwIndex,
DWORD* lpdwType,
LPWSTR lpszName,
DWORD* lpcchName
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| hNetworkEnum | HNETWORKENUM | ClusterNetworkOpenEnum 関数によって最初に返された、既存の列挙オブジェクトへのハンドルです。 |
| dwIndex | DWORD | 次に列挙するエントリを識別するために使用するインデックスです。このパラメーターは、ClusterNetworkEnum の最初の呼び出しではゼロを指定し、以降の呼び出しでは 1 ずつ増やします。 |
| lpdwType | DWORD* | 返されるオブジェクトの種類へのポインターです。呼び出しごとに、CLUSTER_NETWORK_ENUM 列挙型の次の値が返されます。 CLUSTER_NETWORK_ENUM_NETINTERFACES (1)オブジェクトはネットワークインターフェイスです。 |
| lpszName | LPWSTR | 返されたオブジェクトの名前を格納する、null で終わる Unicode 文字列へのポインターです。 |
| lpcchName | DWORD* | lpszName バッファーのサイズを文字数で示す値へのポインターです。入力時には、終端の NULL を含めてバッファーが保持できる最大文字数を指定します。出力時には、終端の NULL を除いた、結果として得られる名前の文字数が格納されます。 |
公式ドキュメント
クラスターオブジェクトをネットワーク上で列挙し、呼び出しごとに 1 つのオブジェクトの名前を返します。PCLUSAPI_CLUSTER_NETWORK_ENUM 型は、この関数へのポインターを定義します。
戻り値
この関数は、次のいずれかの値を返します。
| リターンコード/値 | 説明 |
|---|---|
| 操作は正常に完了しました。 | |
|
さらにデータがあります。この値は、lpszName が指すバッファーが結果を保持するのに十分な大きさでない場合に返されます。lpcchName パラメーターには、終端の NULL を除いた結果の文字数が返されます。 |
|
これ以上のデータはありません。この値は、要求された種類のオブジェクトがこれ以上返されない場合に返されます。 |
解説(Remarks)
ClusterNetworkEnum 関数は通常、ネットワークオブジェクトに属する 1 つ以上の種類のオブジェクトのコレクションを反復処理するために使用します。たとえば、アプリケーションがネットワーク上のすべてのネットワークインターフェイスオブジェクトを列挙する場合は、ClusterNetworkOpenEnum を呼び出して、ネットワークインターフェイスオブジェクトを処理できるネットワーク列挙子を開きます。列挙するオブジェクトの種類としてネットワークインターフェイスを指定するには、dwType パラメーターに CLUSTER_NETWORK_ENUM_NETINTERFACES を設定します。アプリケーションは、ClusterNetworkOpenEnum が返すハンドルを使用して ClusterNetworkEnum を繰り返し呼び出し、各オブジェクトを取得します。lpdwType パラメーターは、取得されたオブジェクトの種類を指します。
lpcchName はバイト数ではなく文字数を表し、返されるサイズには終端の NULL が含まれない点に注意してください。バッファーのサイズ指定の詳細については、データサイズの規則を参照してください。
例
オブジェクトの列挙を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)