PGET_INTERFACE_INFO função de retorno de chamada (routprot.h)

Artigo
08/25/2023

A função GetInterfaceInfo obtém as informações de configuração mantidas pelo protocolo de roteamento para uma interface específica.

Sintaxe

PGET_INTERFACE_INFO PgetInterfaceInfo;

DWORD PgetInterfaceInfo(
  [in]      ULONG InterfaceIndex,
  [in]      PVOID InterfaceInfo,
  [in, out] PULONG BufferSize,
  [in]      PULONG StructureVersion,
  [in]      PULONG StructureSize,
  [in]      PULONG StructureCount
)
{...}

Parâmetros

[in] InterfaceIndex

Especifica a interface no conjunto de interfaces configuradas no roteador.

[in] InterfaceInfo

Ponteiro para um buffer que recebe as informações de configuração definidas pelo protocolo associadas à interface . Essas informações são privadas para o protocolo de roteamento.

[in, out] BufferSize

Ponteiro para uma variável DWORD .

Na entrada: essa variável especifica o tamanho, em bytes, do buffer fornecido para receber as informações de configuração.

Na saída: essa variável recebe o tamanho, em bytes, dos dados colocados no buffer. Se o tamanho inicial não for grande o suficiente, essa variável conterá o tamanho necessário para manter todos os dados.

[in] StructureVersion

Especifica a versão das estruturas de informações apontadas pelo parâmetro InterfaceInfo . Em alguns casos, isso é igual à versão do protocolo de roteamento.

[in] StructureSize

Especifica o tamanho de cada uma das estruturas de informações apontadas pelo parâmetro InterfaceInfo . Como algumas estruturas de informações contêm membros de comprimento variável, o protocolo de roteamento não é necessariamente capaz de determinar o tamanho das informações da versão.

[in] StructureCount

Especifica uma contagem do número de estruturas de informações apontadas pelo parâmetro InterfaceInfo . Esse parâmetro é sempre um.

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 códigos de erro a seguir.

Valor	Descrição
ERROR_CAN_NOT_COMPLETE	Falha na tentativa de recuperar as informações.
ERROR_INVALID_PARAMETER	O parâmetro InterfaceIndex é inválido (por exemplo, nenhuma interface existe com esse índice) ou o parâmetro InterfaceInfoSize é NULL.
ERROR_INSUFFICIENT_BUFFER	O tamanho do buffer de saída fornecido não é grande o suficiente para manter as informações solicitadas. O tamanho necessário é retornado na variável DWORD apontada por InterfaceInfoSize.

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	routprot.h

Confira também

Funções de interface de protocolo de roteamento

Referência da interface do protocolo de roteamento

SetInterfaceInfo

Compartilhar via