Win32 API 日本語リファレンス
ホーム › Networking.Clustering › PCLUSAPI_CLUSTER_NODE_ENUM

PCLUSAPI_CLUSTER_NODE_ENUM

コールバック

シグネチャ

DWORD PCLUSAPI_CLUSTER_NODE_ENUM(
    HNODEENUM hNodeEnum,
    DWORD dwIndex,
    DWORD* lpdwType,
    LPWSTR lpszName,
    DWORD* lpcchName
);

パラメーター

フィールド型説明
hNodeEnumHNODEENUMClusterNodeOpenEnum 関数によって最初に返された、既存の列挙オブジェクトへのハンドルです。
dwIndexDWORD列挙する次のエントリを識別するために使用するインデックスです。このパラメーターは、 ClusterNodeEnum の最初の呼び出しではゼロを指定し、以降の呼び出しでは 1 ずつ増やします。
lpdwTypeDWORD*

返されるオブジェクトの種類へのポインターです。呼び出しごとに、 CLUSTER_NODE_ENUM 列挙型の次の値が返されます。

CLUSTER_NODE_ENUM_NETINTERFACES (1)

オブジェクトはネットワークインターフェイスです。

CLUSTER_NODE_ENUM_GROUPS (0x00000002)

オブジェクトはクラスターグループです。

Windows Server 2008: CLUSTER_NODE_ENUM_GROUPS 値は、 Windows Server 2008 R2 より前ではサポートされません。

lpszNameLPWSTR返されるオブジェクトの名前を格納する、null で終わる Unicode 文字列へのポインターです。
lpcchNameDWORD*lpszName バッファーのサイズを文字数で示す値へのポインターです。入力時には、 終端の NULL を含めてバッファーが保持できる最大文字数を指定します。出力時には、終端の NULL を除いた、結果の名前の文字数が設定されます。

公式ドキュメント

ノード にインストールされている ネットワークインターフェイス または グループ を列挙し、呼び出しごとにそれぞれの名前を返します。PCLUSAPI_CLUSTER_NODE_ENUM 型は、この関数へのポインターを定義します。

戻り値

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

リターンコード/値 説明
ERROR_SUCCESS
0
 操作は正常に完了しました。
ERROR_NO_MORE_ITEMS
259 (0x103)
 これ以上のデータはありません。要求された種類のオブジェクトがこれ以上返されない場合に、この値が返されます。
ERROR_MORE_DATA
234 (0xEA)
 さらにデータがあります。lpszName が指すバッファーが結果を保持するのに十分な大きさでない場合に、 この値が返されます。lpcchName パラメーターには、終端の NULL を除いた結果の文字数が 返されます。

解説(Remarks)

ClusterNodeEnum を使用するには、アプリケーションはまず、 dwType パラメーターに CLUSTER_NODE_ENUM_NETINTERFACES を指定して ClusterNodeOpenEnum を呼び出し、 ノードの列挙ハンドルを開きます。詳細については、オブジェクトの列挙 を参照してください。

lpcchName パラメーターはバイト数ではなく文字数を表すこと、および返されるサイズには終端の NULL が含まれないことに注意してください。バッファーのサイズ指定の詳細については、 データサイズの規則 を参照してください。

例

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)