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
指向 Unicode 字符串的指针,其中包含触发事件的群集对象的 ID。 字符串以终止 null 字符结尾。
[in, out, optional] lpcchObjectId
输入时,指向 DWORD 的指针,指定 lpszObjectId 参数可以容纳的最大字符数,包括终止 null 字符。 输出时,指向 DWORD 的指针,指定 lpszObjectId 接收的字符数,不包括终止 null 字符。
[in, out, optional] lpszParentId
指向 Unicode 字符串的指针,其中包含触发事件的群集对象的父级 ID。 字符串以终止 null 字符结尾。
[in, out, optional] lpcchParentId
输入时,指向 DWORD 的指针,指定 lpszParentId 参数可以容纳的最大字符数,包括终止 null 字符。 输出时,指向 DWORD 的指针,该指针指定 lpszParentId 接收的字符数,不包括终止 null 字符。
[in, out, optional] lpszName
指向 Unicode 字符串的指针,该字符串包含触发事件的群集对象的名称。 字符串以终止 null 字符结尾。
[in, out, optional] lpcchName
输入时,指向 DWORD 的指针,指定 lpszName 参数可以容纳的最大字符数,包括终止 null 字符。 输出时,指向 DWORD 的指针,指定 lpszName 接收的字符数(不包括终止 null 字符)。
[in, out, optional] lpszType
指向 Unicode 字符串的指针,该字符串包含触发事件的群集对象的类型。 字符串以终止 null 字符结尾。
[in, out, optional] lpcchType
输入时,指向 DWORD 的指针,指定 lpszType 参数可以容纳的最大字符数,包括终止 null 字符。 输出时,指向 DWORD 的指针,指定 lpszType 接收的字符数,不包括终止 null 字符。
[in, optional] dwMilliseconds
一个超时值,该值指定调用方愿意等待通知的时间。
返回值
如果操作成功,此函数将返回 ERROR_SUCCESS。
如果操作失败,此函数将返回以下 系统错误代码之一。
返回代码/值 | 说明 |
---|---|
|
hChange 参数中表示的句柄无效或已被另一个线程关闭。 |
|
在成功返回通知之前,调用已超时。 |
|
lpszName 参数指向的缓冲区不够大,无法保存结果。 lpcchName 参数返回结果中的字符数,不包括终止 null 字符。 |
要求
要求 | 值 |
---|---|
最低受支持的客户端 | 无受支持的版本 |
最低受支持的服务器 | Windows Server 2012 |
目标平台 | Windows |
标头 | clusapi.h |
Library | ClusAPI.lib |
DLL | ClusAPI.dll |