Função RtmGetExactMatchRoute (rtmv2.h)

Artigo
08/25/2023

A função RtmGetExactMatchRoute pesquisa na tabela de roteamento uma rota que corresponda exatamente à rota especificada. A rota a ser pesquisada é indicada por um endereço de rede, máscara de sub-rede e outros critérios de correspondência de rotas. Se uma correspondência exata for encontrada, as informações da rota serão retornadas.

Sintaxe

DWORD RtmGetExactMatchRoute(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      PRTM_NET_ADDRESS  DestAddress,
  [in]      RTM_MATCH_FLAGS   MatchingFlags,
  [in, out] PRTM_ROUTE_INFO   RouteInfo,
  [in]      ULONG             InterfaceIndex,
  [in]      RTM_VIEW_SET      TargetViews,
  [out]     PRTM_ROUTE_HANDLE RouteHandle
);

Parâmetros

[in] RtmRegHandle

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

[in] DestAddress

Ponteiro para o endereço de rede de destino.

[in] MatchingFlags

Especifica os critérios a serem usados ao pesquisar a rota. Os sinalizadores a seguir são usados.

Constante	Significado
RTM_MATCH_FULL	Corresponder rotas com todos os critérios.
RTM_MATCH_INTERFACE	Corresponder rotas que estão na mesma interface.
RTM_MATCH_NEIGHBOUR	Corresponder rotas com o mesmo vizinho.
RTM_MATCH_NEXTHOP	Corresponder rotas que têm o mesmo próximo salto.
RTM_MATCH_NONE	Não corresponde a nenhum dos critérios; todas as rotas para o destino são retornadas.
RTM_MATCH_OWNER	Corresponder rotas com o mesmo proprietário.
RTM_MATCH_PREF	Corresponder rotas que têm a mesma preferência.

[in, out] RouteInfo

Na entrada, RouteInfo é um ponteiro RTM_ROUTE_INFO estrutura que contém os critérios que especificam a rota a ser encontrada.

Na saída, RouteInfo recebe as informações de rota para a rota que correspondeu aos critérios.

[in] InterfaceIndex

Se RTM_MATCH_INTERFACE for especificado em MatchingFlags, InterfaceIndex especificará a interface na qual a rota deve estar presente (ou seja, a rota tem um próximo salto nessa interface).

[in] TargetViews

Especifica os modos de exibição dos quais as informações serão retornadas. 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] RouteHandle

Se um identificador precisar ser retornado: Na entrada, RouteHandle será um ponteiro para NULL.

Na saída, RouteHandle recebe um ponteiro para o identificador de rota; caso contrário, RouteHandle permanecerá inalterado.

Se um identificador não precisar ser retornado: Na entrada, RouteHandle será NULL.

Valor retornado

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	Significado
ERROR_NOT_FOUND	A rota especificada não foi encontrada.

Comentários

Considere usar RtmGetExactMatchDestination se você não tiver critérios de correspondência de rota especificados no parâmetro MatchingFlags .

Os seguintes membros da estrutura RTM_ROUTE_INFO que é passada no parâmetro RouteInfo são usados para corresponder a uma rota:

Vizinho
NextHopsList
PrefInfo
RouteOwner

Requisitos


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