Función RtmGetRouteInfo (rtmv2.h)

La función RtmGetRouteInfo devuelve información para la ruta especificada.

Sintaxis

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

Parámetros

[in] RtmRegHandle

Identificador del cliente obtenido de una llamada anterior a RtmRegisterEntity.

[in] RouteHandle

Identificador de la ruta que se va a buscar.

[out] RouteInfo

Si se debe devolver un puntero: en la entrada, RouteInfo es un puntero a NULL. En la salida, RouteInfo recibe un puntero a la ruta; de lo contrario, RouteInfo permanece sin cambios.

Si no es necesario devolver un puntero: en la entrada, RouteInfo es NULL.

[out] DestAddress

Si se debe devolver un puntero: en la entrada, DestAddress es un puntero a NULL. En la salida, DestAddress recibe un puntero a la estructura RTM_NET_ADDRESS del destino; de lo contrario, DestAddress permanece sin cambios.

Si no es necesario devolver un puntero: en la entrada, DestAddress es NULL.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Valor	Significado
ERROR_INVALID_HANDLE	El identificador no es válido.

 

 

Comentarios

Cuando las rutas ya no sean necesarias, liberelas llamando a RtmReleaseRouteInfo.

Requisitos

Requisito	Value
Cliente mínimo compatible	No se admite ninguno
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	rtmv2.h
Library	Rtm.lib
Archivo DLL	Rtm.dll

Consulte también

RTM_NET_ADDRESS

RTM_ROUTE_INFO

RtmReleaseRouteInfo