Função RtmGetMostSpecificDestination (rtmv2.h)

Artigo
03/05/2024

A função RtmGetMostSpecificDestination pesquisa a tabela de roteamento de um destino com a correspondência exata de um endereço de rede e máscara de sub-rede especificados; se a correspondência exata não for encontrada, o melhor prefixo será correspondido. As informações de destino são retornadas.

Sintaxe

DWORD RtmGetMostSpecificDestination(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  PRTM_NET_ADDRESS  DestAddress,
  [in]  ULONG             ProtocolId,
  [in]  RTM_VIEW_SET      TargetViews,
  [out] PRTM_DEST_INFO    DestInfo
);

Parâmetros

[in] RtmRegHandle

Manipule para o cliente obtido de uma chamada anterior para RtmRegisterEntity.

[in] DestAddress

Ponteiro para o endereço de rede de destino.

[in] ProtocolId

Especifica o identificador de protocolo. O ProtocolID não faz parte dos critérios de pesquisa. O gerenciador de tabelas de roteamento usa esse identificador para determinar quais informações de rota devem ser retornadas. Por exemplo, se um cliente especificar o identificador de protocolo RIP, a melhor rota RIP será retornada, mesmo que uma rota não RIP seja a melhor rota para o destino.

Especifique RTM_BEST_PROTOCOL para retornar uma rota, independentemente de qual protocolo a possui. Especifique RTM_THIS_PROTOCOL para retornar a melhor rota para o protocolo de chamada.

[in] TargetViews

Especifica as exibições das quais retornar informações. Se o cliente especificar RTM_VIEW_MASK_ANY, as informações de destino serão retornadas de todas as exibições; no entanto, nenhuma informação específica da exibição é retornada.

[out] DestInfo

Na entrada, DestInfo é um ponteiro para uma estrutura RTM_DEST_INFO .

Na saída, DestInfo é preenchido com as informações de destino solicitadas.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro.

Valor	Significado
ERROR_INVALID_HANDLE	O identificador é inválido.
ERROR_NOT_FOUND	O destino especificado não foi encontrado.

Comentários

A estrutura DestInfo é uma estrutura de tamanho variável. Se o cliente especificar mais de uma exibição com TargetViews, o tamanho de DestInfo aumentará para cada exibição. Use a macro RTM_SIZE_OF_DEST_INFO para determinar quanta memória alocar para a estrutura DestInfo antes de chamar essa função. Use o valor especificado para TargetViews como um parâmetro para RTM_SIZE_OF_DEST_INFO.

Para obter o código de exemplo que usa essa função, consulte Pesquisar rotas usando uma árvore de prefixo.

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]
Plataforma de Destino	Windows
Cabeçalho	rtmv2.h
Biblioteca	Rtm.lib
DLL	Rtm.dll