Função RtmRegisterClient

Artigo
06/13/2023

[Essa API foi substituída pela API do Gerenciador de Tabelas de Roteamento versão 2 e não estará disponível além do Windows Server 2003. Os aplicativos devem usar a API do Gerenciador de Tabelas de Roteamento versão 2.]

A função RtmRegisterClient registra um cliente como um manipulador do protocolo especificado. Ele estabelece um mecanismo de notificação de alteração de rota para o cliente e define opções de protocolo.

Sintaxe

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

Parâmetros

ProtocolFamily [in]

Especifica a família de protocolos do protocolo de roteamento a ser registrado.

RoutingProtocol [in]

Especifica o identificador de protocolo de roteamento, o mesmo usado ao se registrar no gerenciador de roteadores. Consulte RegisterProtocol.

ChangeEvent [in]

Especifica que uma melhor rota para uma rede na tabela foi alterada. O gerenciador de tabelas de roteamento sinaliza esse evento após uma alteração para a melhor rota para qualquer rede na tabela. Consulte RtmDequeueRouteChangeMessage para obter mais informações sobre a notificação de alteração de rota.

Esse parâmetro é opcional. Se o chamador especificar NULL para esse parâmetro, o gerenciador de tabelas de roteamento não notificará o cliente sobre as alterações na melhor rota status.

Sinalizadores [in]

Especifica opções diversas para tratamento especial do protocolo de roteamento. No momento, há suporte para o valor a seguir.

Flags	Significado
RTM_PROTOCOL_SINGLE_ROUTE	O gerenciador de tabelas de roteamento mantém apenas uma rota por rede de destino para o protocolo de roteamento. Em outras palavras, o gerenciador de tabelas de roteamento substitui entradas de rota que têm os mesmos números de rede de destino em vez de adicionar novos.

Valor retornado

No retorno bem-sucedido, um valor HANDLE que identifica o cliente em chamadas subsequentes para o gerenciador de tabelas de roteamento.

Um identificador NULL indica que o gerenciador de tabelas de roteamento não pôde registrar o cliente. Chame GetLastError para obter o motivo da falha.

Valor	Descrição
ERROR_CLIENT_ALREADY_EXISTS	Outro cliente já se registrou para lidar com o protocolo especificado.
ERROR_INVALID_PARAMETER	Não há suporte para a família de protocolos especificada ou o parâmetro Flags é inválido.
ERROR_NO_SYSTEM_RESOURCES	Recursos insuficientes para executar a operação.
ERROR_NOT_ENOUGH_MEMORY	Memória insuficiente para alocar estruturas de dados para o cliente.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Nenhum compatível
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Fim do suporte ao servidor	Windows Server 2003
Cabeçalho	Rtm.h
Biblioteca	Rtm.lib
DLL	Rtm.dll

Confira também

Referência do Gerenciador de Tabelas de Roteamento versão 1
Funções do Gerenciador de Tabelas de Roteamento versão 1
Getlasterror
RegisterProtocol
Identificadores da família de protocolo RTMv1
RtmDequeueRouteChangeMessage
RtmDeregisterClient

Compartilhar via