Función RtmGetEnumRoutes (rtmv2.h)

La función RtmGetEnumRoutes recupera el siguiente conjunto de rutas de la enumeración especificada.

Sintaxis

DWORD RtmGetEnumRoutes(
  [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 enumeración de ruta.

[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, RouteHandles es un puntero a una estructura RTM_ROUTE_INFO .

En la salida, RouteHandles recibe una matriz de identificadores para las rutas.

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_PARAMETER	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.
ERROR_NO_MORE_ITEMS	No hay más rutas para enumerar.
ERROR_NOT_ENOUGH_MEMORY	No hay suficiente memoria para completar esta operación.

 

 

Comentarios

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

Para obtener código de ejemplo con esta función, vea Enumerar todas las rutas.

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

RtmCreateRouteEnum

RtmDeleteEnumHandle

RtmReleaseRoutes