Функция GetClusterNotifyV2 (clusapi.h)

Статья
08/22/2023

Извлекает сведения о следующем событии уведомления для порта уведомлений.

Синтаксис

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

Указатель на размер параметра buffer в байтах.

[in, out, optional] lpszObjectId

Указатель на строку Юникода с идентификатором объекта кластера, который активировал событие. Строка заканчивается завершающим символом NULL.

[in, out, optional] lpcchObjectId

На входных данных — указатель на DWORD , указывающий максимальное количество символов, которое может содержать параметр lpszObjectId , включая завершающий символ NULL. В выходных данных — указатель на DWORD , указывающий количество символов, полученных lpszObjectId , за исключением завершающего символа NULL.

[in, out, optional] lpszParentId

Указатель на строку Юникода с идентификатором родительского объекта кластера, который активировал событие. Строка заканчивается завершающим символом NULL.

[in, out, optional] lpcchParentId

На входных данных — указатель на DWORD , указывающий максимальное количество символов, которое может содержать параметр lpszParentId , включая завершающий символ NULL. В выходных данных — указатель на DWORD , указывающий количество символов, полученных lpszParentId , за исключением завершающего пустого символа.

[in, out, optional] lpszName

Указатель на строку Юникода, содержащую имя объекта кластера, который активировал событие. Строка заканчивается завершающим символом NULL.

[in, out, optional] lpcchName

На входных данных — указатель на DWORD , указывающий максимальное количество символов, которое может содержать параметр lpszName , включая завершающий символ NULL. В выходных данных — указатель на DWORD , указывающий количество полученных символов lpszName , за исключением завершающего символа NULL.

[in, out, optional] lpszType

Указатель на строку Юникода, содержащую тип объекта кластера, который активировал событие. Строка заканчивается завершающим символом NULL.

[in, out, optional] lpcchType

На входных данных — указатель на DWORD , указывающий максимальное количество символов, которое может содержать параметр lpszType , включая завершающий символ NULL. В выходных данных — указатель на DWORD , указывающий количество символов, полученных lpszType , за исключением завершающего символа NULL.

[in, optional] dwMilliseconds

Значение времени ожидания, указывающее, как долго вызывающий объект готов ждать уведомления.

Возвращаемое значение

Если операция выполнена успешно, эта функция возвращает ERROR_SUCCESS.

Если операция завершается сбоем, эта функция возвращает один из следующих кодов системных ошибок.

Возвращаемый код/значение	Описание
ERROR_INVALID_HANDLE 6	Дескриптор, представленный в параметре hChange , недопустим или закрыт другим потоком.
WAIT_TIMEOUT 258 (0x102)	Истекло время ожидания звонка, прежде чем уведомление может быть успешно возвращено.
ERROR_MORE_DATA 234 (0xEA)	Буфер, на который указывает параметр lpszName , недостаточно велик для хранения результата. Параметр lpcchName возвращает количество символов в результате, за исключением завершающего символа NULL.

Требования

Требование	Значение
Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows Server 2012
Целевая платформа	Windows
Header	clusapi.h
Библиотека	ClusAPI.lib
DLL	ClusAPI.dll

См. также раздел

Функция управления отказоустойчивости кластеров

Поделиться через