ホーム › Networking.Clustering › PCLUSAPI_GET_CLUSTER_NODE_ID

PCLUSAPI_GET_CLUSTER_NODE_ID

コールバック

シグネチャ

DWORD PCLUSAPI_GET_CLUSTER_NODE_ID(
    HNODE hNode,
    LPWSTR lpszNodeId,
    DWORD* lpcchName
);

パラメーター

フィールド	型	説明
hNode	HNODE	識別子を取得するノードのハンドル、または NULL です。 hNode に NULL を指定した場合、アプリケーションが実行されているノードのノード識別子が lpszNodeId の内容として返されます。
lpszNodeId	LPWSTR	このパラメーターは、終端の NULL 文字を含む hNode の一意な ID を受け取るバッファーを指します。
lpcchName	DWORD*	入力時は、 lpszNodeId パラメーターが指すバッファーの文字数(NULL 終端文字を含む)へのポインターです。出力時は、バッファーに格納された文字数(NULL 終端文字を除く)へのポインターです。

公式ドキュメント

クラスターノードの一意な識別子を返します。PCLUSAPI_GET_CLUSTER_NODE_ID 型は、この関数へのポインターを定義します。

戻り値

この関数はシステムエラーコードを返します。返される可能性がある値は次のとおりです。

戻り値/値	説明
ERROR_SUCCESS 0	操作は正常に完了しました。
ERROR_MORE_DATA 234 (0xEA)	さらにデータがあります。この値は、 lpszNodeId が指すバッファーが必要な文字数を保持するのに十分な長さでない場合に返されます。 GetClusterNodeId は、 lpcchName の内容に必要な長さを設定します。

解説(Remarks)

PCLUSAPI_GET_CLUSTER_NODE_ID 型は、この関数へのポインターを定義します。

hNode に NULL を指定し、呼び出し元がアクティブなクラスターノード上で実行されている場合、GetClusterNodeId 関数は、アプリケーションが実行されているノードの識別子を返します。hNode に NULL を指定する方法は、リソース DLL が自身の実行されているノードのノード識別子を判別するための簡便な手段です。hNode パラメーターに NULL を渡す代わりに、GetCurrentClusterNodeId マクロを使用することもできます。

クラスターノード識別子は一意な識別子であり、ノードの名前が変更されても変化しません。

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

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