Função RtmDeleteRoute
[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 RtmDeleteRoute exclui uma entrada de rota.
DWORD RtmDeleteRoute(
_In_ HANDLE ClientHandle,
_In_ PVOID Route,
_Out_ DWORD Flags,
_Out_ PVOID CurBestRoute
);
-
ClientHandle [in]
-
Identificador que identifica o cliente e, portanto, o protocolo de roteamento da rota adicionada ou atualizada. Obtenha esse identificador chamando RtmRegisterClient.
-
Rotear [in]
-
Ponteiro para uma estrutura específica da família de protocolos que especifica a rota nova ou atualizada. Os campos a seguir são usados pelo gerenciador de tabelas de roteamento para atualizar a tabela de roteamento:
Valor Significado - RR_Network
Especifica o número da rede de destino. - RR_InterfaceID
Especifica o índice da interface pela qual a rota foi recebida. - RR_NextHopAddress
Especifica o endereço de rede do roteador do próximo salto. -
Sinalizadores [out]
-
Ponteiro para um conjunto de sinalizadores que indicam o tipo da mensagem de alteração e quais informações foram colocadas nos buffers fornecidos. Esse parâmetro é um dos valores a seguir.
Flags Significado - RTM_NO_CHANGE
A exclusão da rota não afetou a melhor rota para nenhuma rede de destino. Em outras palavras, outra entrada representa uma rota para a mesma rede de destino e tem uma métrica menor. - RTM_ROUTE_DELETED
A rota excluída era a única rota disponível para uma rede de destino específica. - RTM_ROUTE_CHANGED
Depois que essa rota foi excluída, outra rota se tornou a melhor rota para uma rede de destino específica. CurBestRoute aponta para as informações para a nova melhor rota. -
CurBestRoute [out]
-
Ponteiro para uma estrutura que recebe as informações atuais de melhor rota, se houver. O tipo da estrutura é específico para a família de protocolos, por exemplo, IP ou IPX.
Esse parâmetro é opcional. Se o chamador especificar NULL para esse parâmetro, as informações de melhor rota atuais não serão retornadas.
Se a função for bem-sucedida, o valor retornado será NO_ERROR.
Se a função falhar, o valor retornado será um dos códigos de erro a seguir.
Valor | Descrição |
---|---|
|
O parâmetro de identificador do cliente não é um identificador válido. |
|
A estrutura de rota apontada pelo parâmetro Route contém um valor de membro. |
|
Não há entradas na tabela de roteamento que correspondam aos parâmetros da rota especificada. |
|
Não há recursos suficientes para executar a operação. |
A função gerará uma mensagem de alteração de rota se a melhor rota para uma rede de destino tiver sido alterada como resultado da exclusão. No entanto, a mensagem de alteração de rota não é enviada ao cliente que faz essa chamada. Em vez disso, as informações relevantes são retornadas por essa função diretamente para esse cliente.
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 |
|
Biblioteca |
|
DLL |
|