GetClusterNotifyV2 関数 (clusapi.h)
通知ポートの次の通知イベントに関する情報を取得します。
構文
DWORD GetClusterNotifyV2(
[in] HCHANGE hChange,
[out] DWORD_PTR *lpdwNotifyKey,
[in, out, optional] PNOTIFY_FILTER_AND_TYPE pFilterAndType,
[in, out, optional] BYTE *buffer,
[in, out, optional] LPDWORD lpbBufferSize,
[in, out, optional] LPWSTR lpszObjectId,
[in, out, optional] LPDWORD lpcchObjectId,
[in, out, optional] LPWSTR lpszParentId,
[in, out, optional] LPDWORD lpcchParentId,
[in, out, optional] LPWSTR lpszName,
[in, out, optional] LPDWORD lpcchName,
[in, out, optional] LPWSTR lpszType,
[in, out, optional] LPDWORD lpcchType,
[in, optional] DWORD dwMilliseconds
);
パラメーター
[in] hChange
通知ポートへのハンドル。 このハンドルは、 CreateClusterNotifyPortV2 関数によって作成されます。
[out] lpdwNotifyKey
通知ポートの通知キーへのポインター。
[in, out, optional] pFilterAndType
通知ポートの次の通知イベントを記述する NOTIFY_FILTER_AND_TYPE 構造体へのポインター。
[in, out, optional] buffer
通知イベントのバッファーへのポインター。
[in, out, optional] lpbBufferSize
バッファー パラメーターのサイズへのポインター (バイト単位)。
[in, out, optional] lpszObjectId
イベントをトリガーしたクラスター オブジェクトの ID を持つ Unicode 文字列へのポインター。 文字列は終端の null 文字で終わります。
[in, out, optional] lpcchObjectId
入力時に、lpszObjectId パラメーターが保持できる最大文字数 (終端の null 文字を含む) を指定する DWORD へのポインター。 出力時に、lpszObjectId が受け取った文字数 (終端の null 文字を除く) を指定する DWORD へのポインター。
[in, out, optional] lpszParentId
イベントをトリガーしたクラスター オブジェクトへの親の ID を持つ Unicode 文字列へのポインター。 文字列は終端の null 文字で終わります。
[in, out, optional] lpcchParentId
入力時に、lpszParentId パラメーターが保持できる最大文字数 (終端の null 文字を含む) を指定する DWORD へのポインター。 出力時に、lpszParentId が受け取った文字数 (終端の null 文字を除く) を指定する DWORD へのポインター。
[in, out, optional] lpszName
イベントをトリガーしたクラスター オブジェクトの名前を含む Unicode 文字列へのポインター。 文字列は終端の null 文字で終わります。
[in, out, optional] lpcchName
入力時に、lpszName パラメーターが保持できる最大文字数 (終端の null 文字を含む) を指定する DWORD へのポインター。 出力時に、lpszName が受け取った文字数 (終端の null 文字を除く) を指定する DWORD へのポインター。
[in, out, optional] lpszType
イベントをトリガーしたクラスター オブジェクトの種類を含む Unicode 文字列へのポインター。 文字列は終端の null 文字で終わります。
[in, out, optional] lpcchType
入力時に、lpszType パラメーターが保持できる最大文字数 (終端の null 文字を含む) を指定する DWORD へのポインター。 出力時に、lpszType が受け取った文字数 (終端の null 文字を除く) を指定する DWORD へのポインター。
[in, optional] dwMilliseconds
呼び出し元が通知を待機する期間を指定するタイムアウト値。
戻り値
操作が成功した場合、この関数は ERROR_SUCCESSを返します。
操作が失敗した場合、この関数は次のいずれかの システム エラー コードを返します。
リターン コード/値 | Description |
---|---|
|
hChange パラメーターで表されるハンドルが無効であるか、別のスレッドによって閉じられています。 |
|
通知が正常に返される前に、呼び出しがタイムアウトしました。 |
|
lpszName パラメーターが指すバッファーは、結果を保持するのに十分な大きさではありません。 lpcchName パラメーターは、終端の null 文字を除き、結果の文字数を返します。 |
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows Server 2012 |
対象プラットフォーム | Windows |
ヘッダー | clusapi.h |
Library | ClusAPI.lib |
[DLL] | ClusAPI.dll |