Función RtmRegisterClient

[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 RtmRegisterClient registra un cliente como controlador del protocolo especificado. Establece un mecanismo de notificación de cambio de ruta para el cliente y establece las opciones de protocolo.

Sintaxis

HANDLE RtmRegisterClient(
  _In_ DWORD  ProtocolFamily,
  _In_ DWORD  RoutingProtocol,
  _In_ HANDLE ChangeEvent,
  _In_ DWORD  Flags
);

Parámetros

ProtocolFamily [in]

Especifica la familia de protocolos del protocolo de enrutamiento que se va a registrar.

RoutingProtocol [in]

Especifica el identificador del protocolo de enrutamiento, igual que el usado al registrarse con el administrador de enrutadores. Consulte RegisterProtocol.

ChangeEvent [in]

Especifica que ha cambiado una mejor ruta a una red de la tabla. El administrador de tablas de enrutamiento señala este evento después de un cambio en la mejor ruta a cualquier red de la tabla. Consulte RtmDequeueRouteChangeMessage para obtener más información sobre la notificación de cambio de ruta.

Este parámetro es opcional. Si el autor de la llamada especifica NULL para este parámetro, el administrador de tablas de enrutamiento no notifica al cliente los cambios en el mejor estado de ruta.

Marcas [in]

Especifica varias opciones para el control especial del protocolo de enrutamiento. Actualmente se admite el siguiente valor.

Marcas Significado
RTM_PROTOCOL_SINGLE_ROUTE
El administrador de tablas de enrutamiento mantiene solo una ruta por red de destino para el protocolo de enrutamiento. En otras palabras, el administrador de tablas de enrutamiento reemplaza las entradas de ruta que tienen los mismos números de red de destino en lugar de agregar otras nuevas.

Valor devuelto

Si la devolución se realiza correctamente, un valor HANDLE que identifica al cliente en llamadas posteriores al administrador de tablas de enrutamiento.

Un identificador NULL indica que el administrador de tablas de enrutamiento no pudo registrar el cliente. Llame a GetLastError para obtener el motivo del error.

Valor Descripción
ERROR_CLIENT_ALREADY_EXISTS
Otro cliente ya se ha registrado para controlar el protocolo especificado.
ERROR_INVALID_PARAMETER
No se admite la familia de protocolos especificada o el parámetro Flags no es válido.
ERROR_NO_SYSTEM_RESOURCES
Recursos insuficientes para llevar a cabo la operación.
ERROR_NOT_ENOUGH_MEMORY
Memoria insuficiente para asignar estructuras de datos para el cliente.

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
Rtm.h
Biblioteca
Rtm.lib
Archivo DLL
Rtm.dll

Consulte también

Referencia del Administrador de tablas de enrutamiento versión 1

Funciones del Administrador de tablas de enrutamiento versión 1

GetLastError

RegisterProtocol

Identificadores de familia de protocolo RTMv1

RtmDequeueRouteChangeMessage

RtmDeregisterClient