Функция RtmGetEnumDests (rtmv2.h)
Функция RtmGetEnumDests извлекает следующий набор назначений в указанном перечислении.
Синтаксис
DWORD RtmGetEnumDests(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumDests,
[out] PRTM_DEST_INFO DestInfos
);
Параметры
[in] RtmRegHandle
Дескриптор клиента, полученного при предыдущем вызове RtmRegisterEntity.
[in] EnumHandle
Обработка перечисления назначения.
[in, out] NumDests
На входных данных NumDests является указателем на значение UINT , указывающее максимальное количество назначений, которые могут быть получены DestInfos. В выходных данных NumDests получает фактическое число назначений, полученных DestInfos.
[out] DestInfos
При входных данных DestInfos является указателем на структуру RTM_DEST_INFO .
В выходных данных DestInfos получает массив дескрипторов для назначений.
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.
Если функция завершается сбоем, возвращается один из следующих кодов ошибок.
| Значение | Значение |
|---|---|
|
Значение, на которое указывает NumRoutes , больше максимального числа маршрутов, которые клиент может получить с помощью одного вызова. Проверьте RTM_REGN_PROFILE на наличие максимального количества назначений, которые клиент может получить с помощью одного вызова. |
|
Больше нет назначений для перечисления. |
Комментарии
Структура, на которую указывает DestInfos , представляет собой структуру с переменным размером. Если клиент указывает несколько представлений в TargetViews, размер DestInfos увеличивается для каждого представления. Используйте макрос RTM_SIZE_OF_DEST_INFO , чтобы определить, насколько велика структура DestInfos для выделения перед вызовом этой функции. Используйте значение, указанное для TargetViews , в качестве параметра для RTM_SIZE_OF_DEST_INFO.
Если назначения больше не требуются, отпустите их, вызвав RtmReleaseDests.
Пример кода, использующий эту функцию, см. в разделе Перечисление всех назначений.
Требования
| Минимальная версия клиента | Ни одна версия не поддерживается |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | rtmv2.h |
| Библиотека | Rtm.lib |
| DLL | Rtm.dll |