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

PCLUSAPI_GET_CLUSTER_INFORMATION

コールバック

シグネチャ

DWORD PCLUSAPI_GET_CLUSTER_INFORMATION(
    HCLUSTER hCluster,
    LPWSTR lpszClusterName,
    DWORD* lpcchClusterName,
    CLUSTERVERSIONINFO* lpClusterInfo
);

パラメーター

フィールド型説明
hClusterHCLUSTERクラスターのハンドルです。
lpszClusterNameLPWSTRhCluster で識別されるクラスターの名前を格納する、null で終わる Unicode 文字列へのポインターです。
lpcchClusterNameDWORD*lpszClusterName バッファーのサイズを文字数で表した値へのポインターです。入力時には、終端の NULL を含め、バッファーが保持できる最大文字数を指定します。出力時には、終端の NULL を除いた、結果として得られる名前の文字数が格納されます。
lpClusterInfoCLUSTERVERSIONINFO*NULL であるか、クラスターサービスのバージョンを記述する CLUSTERVERSIONINFO 構造体へのポインターです。lpClusterInfo が NULL でない場合、この構造体の dwVersionInfoSize メンバーは次のように設定する必要があります。lpClusterInfo->dwVersionInfoSize = sizeof(CLUSTERVERSIONINFO);

公式ドキュメント

クラスターの名前とバージョンを取得します。PCLUSAPI_GET_CLUSTER_INFORMATION 型は、この関数へのポインターを定義します。

戻り値

操作が成功した場合、この関数は ERROR_SUCCESS (0) を返します。

操作が失敗した場合、この関数は システム エラー コードを返します。次の値はその一例です。

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

解説(Remarks)

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

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