Função MgmGetProtocolOnInterface (mgm.h)

  • Artigo

A função MgmGetProtocolOnInterface recupera a ID do protocolo de roteamento multicast que possui a interface especificada.

Sintaxe

DWORD MgmGetProtocolOnInterface(
  [in]      DWORD  dwIfIndex,
  [in]      DWORD  dwIfNextHopAddr,
  [in, out] PDWORD pdwIfProtocolId,
  [in, out] PDWORD pdwIfComponentId
);

Parâmetros

[in] dwIfIndex

Especifica o índice da interface para a qual recuperar a ID do protocolo.

[in] dwIfNextHopAddr

Especifica o endereço do próximo salto que corresponde ao índice especificado por dwIfIndex. Os parâmetros dwIfIndex e dwIfNextHopIPAddr identificam exclusivamente um próximo salto em interfaces ponto a ponto. Uma interface ponto a ponto é uma conexão em que uma interface se conecta a várias redes. Exemplos de interfaces ponto a multipoint incluem interfaces NBMA (acesso múltiplo não difundido) e a interface interna na qual todos os clientes discados se conectam.

Para interfaces de difusão (como interfaces Ethernet) ou interfaces ponto a ponto, que são identificadas apenas pelo valor de dwIfIndex, especifique zero.

[in, out] pdwIfProtocolId

Na entrada, o cliente deve fornecer um ponteiro para um local de memória do tamanho DWORD.

Na saída, pdwIfProtocolId recebe a ID do protocolo na interface especificada por dwIfIndex.

[in, out] pdwIfComponentId

Na entrada, o cliente deve fornecer um ponteiro para um valor DWORD .

Na saída, pdwIfComponentId recebe a ID do componente para a instância do protocolo na interface. Esse parâmetro é usado com pdwIfProtocolId para identificar exclusivamente uma instância de um protocolo de roteamento.

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_CAN_NOT_COMPLETE
 Não foi possível concluir a chamada para essa função.
ERROR_NOT_FOUND
 A interface especificada não foi encontrada pelo gerenciador de grupo multicast.
 
 

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 mgm.h
Biblioteca Rtm.lib
DLL Rtm.dll

Confira também

MgmReleaseInterfaceOwnership

MgmTakeInterfaceOwnership