Compartilhar via

Função RtmGetRouteInfo (rtmv2.h)

  • Artigo

A função RtmGetRouteInfo retorna informações para a rota especificada.

Sintaxe

DWORD RtmGetRouteInfo(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE  RouteHandle,
  [out] PRTM_ROUTE_INFO   RouteInfo,
  [out] PRTM_NET_ADDRESS  DestAddress
);

Parâmetros

[in] RtmRegHandle

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

[in] RouteHandle

Manipule para a rota a ser encontrada.

[out] RouteInfo

Se um ponteiro precisar ser retornado: Na entrada, RouteInfo será um ponteiro para NULL. Na saída, RouteInfo recebe um ponteiro para a rota; caso contrário, RouteInfo permanecerá inalterado.

Se um ponteiro não precisar ser retornado: Na entrada, RouteInfo será NULL.

[out] DestAddress

Se um ponteiro precisar ser retornado: Na entrada, DestAddress será um ponteiro para NULL. Na saída, DestAddress recebe um ponteiro para a estrutura RTM_NET_ADDRESS do destino; caso contrário, DestAddress permanecerá inalterado.

Se um ponteiro não precisar ser retornado: Na entrada, DestAddress será NULL.

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 manipulador é inválido.
 
 

Comentários

Quando as rotas não forem mais necessárias, libere-as chamando RtmReleaseRouteInfo.

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

Confira também

RTM_NET_ADDRESS

RTM_ROUTE_INFO

RtmReleaseRouteInfo