Ler em inglês

Compartilhar via


Função RtmIsRoute

[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 RtmIsRoute determina se existe uma ou mais rotas para uma rede de destino especificada. Nesse caso, a função retorna informações para a melhor rota para essa rede.

Sintaxe

BOOL RtmIsRoute(
  _In_  DWORD ProtocolFamily,
  _In_  PVOID Network,
  _Out_ PVOID BestRoute
);

Parâmetros

ProtocolFamily [in]

Especifica o tipo de estrutura de dados apontado pelo parâmetro Network, por exemplo, IP_NETWORK, IPX_NETWORK.

Rede [in]

Ponteiro para uma estrutura que especifica dados de número de rede específicos da família de protocolos. Esses dados identificam a rede para a qual o chamador busca informações de rota.

BestRoute [out]

Ponteiro para uma estrutura específica da família de protocolos que recebe as melhores informações de rota atuais, se houver.

Valor retornado

O valor retornado é um dos códigos a seguir.

Valor Descrição
TRUE
Existe pelo menos uma rota para a rede especificada. A melhor rota é retornada na estrutura apontada pelo parâmetro BestRoute .
FALSE
Não há nenhuma rota para a rede especificada ou a operação falhou. Chame GetLastError para obter mais informações:
NO_ERROR
A operação foi bem-sucedida, mas não há nenhuma rota para a rede especificada.
ERROR_INVALID_PARAMETER
O valor do parâmetro ProtocolFamily não corresponde a nenhuma família de protocolos instalada.
ERROR_NO_SYSTEM_RESOURCES
Não há recursos suficientes para executar a operação.

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

IP_NETWORK

IPX_NETWORK

Identificadores de família de protocolo RTMv1