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

Статья
03/13/2024

Функция RtmReferenceHandles увеличивает число ссылок на объекты, на которые указывает один или несколько дескрипторов, которые диспетчер маршрутизации использовал для доступа к этим объектам. Клиент должен использовать эту функцию, если клиент должен сохранить дескриптор, но освободить остальную часть информационной структуры, связанной с дескриптором.

Синтаксис

DWORD RtmReferenceHandles(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] UINT              NumHandles,
  [in] HANDLE            *RtmHandles
);

Параметры

[in] RtmRegHandle

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

[in] NumHandles

Указывает количество дескрипторов в RtmHandles.

[in] RtmHandles

Массив дескрипторов для увеличения числа ссылок.

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

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

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

Значение	Значение
ERROR_INVALID_HANDLE	Дескриптор недействителен.

Клиент всегда должен вызывать эту функцию при кэшировании дескриптора, возвращаемого диспетчером таблиц маршрутизации. Это уведомляет диспетчер таблиц маршрутизации о том, что он не должен уничтожать объект, на который ссылается дескриптор, пока этот дескриптор не будет освобожден клиентом.

Когда клиент должен освободить дескриптор, клиент должен вызвать соответствующую функцию выпуска в зависимости от типа дескриптора. Например, чтобы освободить маршрут, вызовите RtmReleaseRoutes.

Требования

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