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

  • Artigo

O gerenciador de roteadores chama a função GetNeighbors para obter o querier para a rede anexada por meio da interface especificada.

O tipo PGET_NEIGHBORS define um ponteiro para essa função de retorno de chamada. GetNeighbors é um espaço reservado para o nome da função definida pelo aplicativo.

Sintaxe

PGET_NEIGHBORS PgetNeighbors;

DWORD PgetNeighbors(
  [in]      DWORD InterfaceIndex,
  [in]      PDWORD NeighborList,
  [in, out] PDWORD NeighborListSize,
  [out]     PBYTE InterfaceFlags
)
{...}

Parâmetros

[in] InterfaceIndex

Especifica o índice da interface na qual o protocolo de roteamento deve fornecer o querier.

[in] NeighborList

Ponteiro para uma matriz de variáveis DWORD . O protocolo de roteamento deve preencher essa matriz com o endereço do querier.

Se o computador local for o querier da rede anexada por meio da interface especificada, o protocolo de roteamento não precisará preencher essa variável. Em vez disso, o protocolo de roteamento deve definir o valor apontado por NeighborListSize como zero. Além disso, o protocolo de roteamento deve adicionar MRINFO_QUERIER_FLAG aos sinalizadores retornados no parâmetro InterfaceFlags .

[in, out] NeighborListSize

Na entrada, ponteiro para uma variável DWORD .

Na saída, o protocolo de roteamento preenche essa variável com o comprimento, em bytes, do endereço retornado no parâmetro NeighborList .

[out] InterfaceFlags

Recebe um ou mais dos sinalizadores a seguir. Os sinalizadores descrevem a relação do computador local com outros computadores na rede anexada por meio da interface especificada.

MRINFO_TUNNEL_FLAGMRINFO_PIM_FLAG MRINFO_DOWN_FLAGMRINFO_DOWN_FLAGMRINFO_DISABLED_FLAG MRINFO_QUERIER_FLAGMRINFO_LEAF_FLAG

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
 O protocolo de roteamento não pôde concluir a solicitação.
ERROR_INSUFFICIENT_BUFFER
 O tamanho do buffer apontado por NeighborList não é grande o suficiente para manter o endereço. O tamanho necessário é retornado na variável DWORD apontada pelo parâmetro NeighborListSize .
ERROR_INVALID_PARAMETER
 O parâmetro InterfaceIndex é inválido (por exemplo, nenhuma interface existe com esse índice).

Comentários

Somente protocolos de roteamento multicast são necessários para implementar essa função. Os protocolos de roteamento não multicast devem passar NULL como o valor do ponteiro para essa função no MPR_ROUTING_CHARACTERISTICS

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

GetMfeStatus