Функция RtmGetChangedDests (rtmv2.h)

Статья
03/05/2024

Функция RtmGetChangedDests возвращает набор назначений с измененными сведениями.

Синтаксис

DWORD RtmGetChangedDests(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_NOTIFY_HANDLE NotifyHandle,
  [in, out] PUINT             NumDests,
  [out]     PRTM_DEST_INFO    ChangedDests
);

Параметры

[in] RtmRegHandle

Дескриптор клиента, полученного при предыдущем вызове RtmRegisterEntity.

[in] NotifyHandle

Обработка уведомления об изменении, полученного при предыдущем вызове RtmRegisterForChangeNotification.

[in, out] NumDests

При входе NumDests является указателем на значение UINT , указывающее максимальное количество назначений, которые могут быть получены ChangedDests.

В выходных данных NumDests получает фактическое количество назначений, полученных ChangedDests.

[out] ChangedDests

На входных данных ChangedDests является указателем на массив RTM_DEST_INFO структур.

В выходных данных ChangedDests заполняется измененными сведениями о назначении.

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Параметр содержит неверные сведения.
ERROR_NO_MORE_ITEMS	Больше нет измененных назначений для извлечения.

Клиент получает уведомление об изменениях RTM_EVENT_CALLBACK. RTM_EVENT_CALLBACK используется только для уведомления клиента, а не для доставки изменений. После получения уведомления об изменении клиент должен повторно вызывать RtmGetChangedDests , чтобы получить все изменения.

Если с момента уведомления произошло несколько изменений в одном месте назначения, возвращается только последнее изменение.

Если клиенту больше не нужны дескрипторы в ChangedDests, он должен использовать RtmReleaseChangedDests для освобождения дескрипторов.

Пример кода, использующий эту функцию, см. в разделе Использование обратного вызова уведомления о событиях.

Требования

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