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

PCLUSAPI_GET_CLUSTER_NET_INTERFACE

コールバック

シグネチャ

DWORD PCLUSAPI_GET_CLUSTER_NET_INTERFACE(
    HCLUSTER hCluster,
    LPWSTR lpszNodeName,
    LPWSTR lpszNetworkName,
    LPWSTR lpszInterfaceName,
    DWORD* lpcchInterfaceName
);

パラメーター

フィールド型説明
hClusterHCLUSTERクラスターへのハンドルです。
lpszNodeNameLPWSTRクラスター内のノードの名前を格納した、null で終わる Unicode 文字列へのポインターです。
lpszNetworkNameLPWSTRネットワークの名前を格納した、null で終わる Unicode 文字列へのポインターです。
lpszInterfaceNameLPWSTRネットワークインターフェイスの名前を受け取る出力バッファーへのポインターです。
lpcchInterfaceNameDWORD*lpszInterfaceName バッファーのサイズを文字数で示す値へのポインターです。入力時には、終端の NULL を含めてバッファーが保持できる最大文字数を指定します。出力時には、終端の NULL を除いた、結果として得られた名前の文字数が格納されます。

公式ドキュメント

クラスター内のネットワークに対する、ノードのインターフェイス名を返します。PCLUSAPI_GET_CLUSTER_NET_INTERFACE 型は、この関数へのポインターを定義します。

戻り値

処理に成功した場合、この関数は ERROR_SUCCESS を返します。

処理に失敗した場合、 この関数はシステムエラーコードを返します。次の値は、返される可能性のある値の 1 つです。

戻り値 説明
ERROR_MORE_DATA
lpszInterfaceName が指すバッファーが、結果を保持するのに十分な大きさではありません。lpcchInterfaceName パラメーターには、終端の NULL を除いた結果の文字数が返されます。

解説(Remarks)

lpcchInterfaceName はバイト数ではなく文字数を表し、返されるサイズには終端の NULL が含まれない点に注意してください。バッファーのサイズ指定について詳しくは、データサイズの規則を参照してください。

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