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

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

  • Статья

Функция RtmGetRouteInfo возвращает сведения для указанного маршрута.

Синтаксис

DWORD RtmGetRouteInfo(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE  RouteHandle,
  [out] PRTM_ROUTE_INFO   RouteInfo,
  [out] PRTM_NET_ADDRESS  DestAddress
);

Параметры

[in] RtmRegHandle

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

[in] RouteHandle

Дескриптор к маршруту для поиска.

[out] RouteInfo

Если необходимо вернуть указатель: во входных данных RouteInfo является указателем на NULL. В выходных данных RouteInfo получает указатель на маршрут; В противном случае Значение RouteInfo остается без изменений.

Если указатель не требуется возвращать: на входных данных Значение RouteInfo имеет значение NULL.

[out] DestAddress

Если необходимо вернуть указатель: при входных данных DestAddress является указателем на NULL. В выходных данных DestAddress получает указатель на структуру RTM_NET_ADDRESS назначения; В противном случае DestAddress остается без изменений.

Если указатель не требуется возвращать: при входных данных DestAddress имеет значение NULL.

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

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

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

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

Комментарии

Если маршруты больше не требуются, отпустите их, вызвав RtmReleaseRouteInfo.

Требования

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

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

RTM_NET_ADDRESS

RTM_ROUTE_INFO

RtmReleaseRouteInfo