Función RtmGetListEnumRoutes (rtmv2.h)
La función RtmGetListEnumRoutes enumera un conjunto de rutas en una lista de rutas especificada.
Sintaxis
DWORD RtmGetListEnumRoutes(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumRoutes,
[out] PRTM_ROUTE_HANDLE RouteHandles
);
Parámetros
[in] RtmRegHandle
Identificador del cliente obtenido de una llamada anterior a RtmRegisterEntity.
[in] EnumHandle
Identificador de la lista de rutas que se va a enumerar.
[in, out] NumRoutes
En la entrada, NumRoutes es un puntero a un valor UINT que especifica el número máximo de rutas que routeHandles puede recibir.
En la salida, NumRoutes recibe el número real de rutas recibidas por RouteHandles.
[out] RouteHandles
En la entrada, DestInfo es un puntero a una matriz de estructuras RTM_DEST_INFO .
En la salida, DestInfo se rellena con la información de destino solicitada.
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 |
|---|---|
|
El valor al que apunta NumRoutes es mayor que el número máximo de rutas que un cliente puede recuperar con una llamada. Compruebe RTM_REGN_PROFILE el número máximo de rutas que el cliente puede recuperar con una llamada. |
Comentarios
Llame a esta función repetidamente para recuperar todas las rutas.
No hay más rutas para enumerar cuando el administrador de tablas de enrutamiento devuelve cero en NumRoutes.
Para obtener código de ejemplo con esta función, consulte Uso de una lista de rutas de Client-Specific.
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 |