Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
[Esta API se ha reemplazado por la API del Administrador de tablas de enrutamiento versión 2 y no estará disponible más allá de Windows Server 2003. Las aplicaciones deben usar la API routing Table Manager versión 2.]
La función RtmDequeueRouteChangeMessage devuelve el siguiente mensaje de cambio de ruta en la cola asociada al cliente especificado.
Sintaxis
DWORD RtmDequeueRouteChangeMessage(
_In_ HANDLE ClientHandle,
_Out_ DWORD Flags,
_Out_ PVOID CurBestRoute,
_Out_ PVOID PrevBestRoute
);
Parámetros
-
ClientHandle [in]
-
Identificador que identifica el cliente para el que se realiza la operación. Obtenga este identificador llamando a RtmRegisterClient.
-
Marcas [out]
-
Puntero a una variable DWORD . El administrador de tablas de enrutamiento establece el valor de esta variable. El valor especifica el tipo del mensaje de cambio y qué información se devolvió en los búferes proporcionados. Este parámetro es uno de los siguientes.
Marcas Significado - RTM_ROUTE_ADDED
La primera ruta se agregó para una red de destino determinada. El parámetro CurBestRoute apunta a la información de la ruta agregada. - RTM_ROUTE_DELETED
Se eliminó la única ruta disponible para una red de destino determinada. El parámetro PrevBestRoute apunta a la información de la ruta eliminada. - RTM_ROUTE_CHANGED
Se cambió al menos uno de los parámetros significativos para una mejor ruta a una red de destino determinada. Los parámetros significativos son:
Identificador de protocolo
Índice de interfaz
Dirección del próximo salto
Datos específicos de la familia de protocolos (incluidas las métricas de ruta)El parámetro PrevBestRoute apunta a la información de ruta tal como estaba antes del cambio. El parámetro CurBestRoute apunta a la información de ruta actual (es decir, después del cambio).
-
CurBestRoute [out]
-
Puntero a una estructura que recibe la información de la mejor ruta actual (si existe). El tipo de la estructura es específico de la familia de protocolos, por ejemplo, IP o IPX.
Este parámetro es opcional. Si el autor de la llamada especifica NULL para este parámetro, no se devuelve la información de la mejor ruta actual.
-
PrevBestRoute [out]
-
Puntero a una estructura que recibe la información de la mejor ruta anterior, si existe. El tipo de la estructura es específico de la familia de protocolos, por ejemplo, IP o IPX.
Este parámetro es opcional. Si el autor de la llamada especifica NULL para este parámetro, no se devuelve la información de la mejor ruta anterior.
Valor devuelto
El valor devuelto es uno de los siguientes códigos.
| Valor | Descripción |
|---|---|
|
Este mensaje fue el último mensaje de la cola del cliente. El objeto de evento se restablece. |
|
El parámetro ClientHandle no es un identificador válido o, al registrarlo, el cliente no proporcionó un objeto de evento para la notificación de mensaje de cambio (consulte RtmRegisterClient). |
|
La cola del cliente contiene mensajes adicionales. El cliente debe llamar a RtmDequeueRouteChangeMessage lo antes posible para permitir que el administrador de tablas de enrutamiento libere los recursos asociados a los mensajes pendientes. |
|
La cola del cliente no contiene ningún mensaje; la llamada no fue solicitada. El evento se restablece. |
|
No hay recursos suficientes para llevar a cabo la operación. |
Requisitos
| Requisito | Value |
|---|---|
| Cliente mínimo compatible |
No se admite ninguno |
| Servidor mínimo compatible |
Windows 2000 Server [solo aplicaciones de escritorio] |
| Fin de compatibilidad de servidor |
Windows Server 2003 |
| Encabezado |
|
| Biblioteca |
|
| Archivo DLL |
|