Compartilhar via

Função GetMulticastIpAddressEntry (netioapi.h)

  • Artigo

A função GetMulticastIpAddressEntry recupera informações para uma entrada de endereço IP multicast existente no computador local.

Sintaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetMulticastIpAddressEntry(
  [in, out] PMIB_MULTICASTIPADDRESS_ROW Row
);

Parâmetros

[in, out] Row

Um ponteiro para uma entrada de estrutura MIB_MULTICASTIPADDRESS_ROW para uma entrada de endereço IP multicast. No retorno bem-sucedido, essa estrutura será atualizada com as propriedades de um endereço IP multicast existente.

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.

Código de retorno Descrição
ERROR_FILE_NOT_FOUND
 O sistema não pode encontrar o arquivo especificado. Esse erro será retornado se o LUID da interface de rede ou o índice de interface especificado pelo membro InterfaceLuid ou InterfaceIndex do MIB_MULTICASTIPADDRESS_ROW apontado pelo parâmetro Row não for um valor no computador local.
ERROR_INVALID_PARAMETER
 Um parâmetro está incorreto. Esse erro será retornado se um ponteiro NULL for passado no parâmetro Row , o membro Address do MIB_MULTICASTIPADDRESS_ROW apontado pelo parâmetro Row não for definido como um endereço IPv4 ou IPv6 multicast válido ou os membros InterfaceLuid ou InterfaceIndex do MIB_MULTICASTIPADDRESS_ROW apontados pelo parâmetro Row não forem especificados.
ERROR_NOT_FOUND
 Elemento não encontrado. Esse erro será retornado se o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex da estrutura MIB_MULTICASTIPADDRESS_ROW apontada pelo parâmetro Row não corresponder ao endereço IP e à família de endereços especificados no membro Address na estrutura MIB_MULTICASTIPADDRESS_ROW .
ERROR_NOT_SUPPORTED
 A solicitação não terá suporte. Esse erro será retornado se nenhuma pilha IPv4 estiver no computador local e um endereço IPv4 for especificado no membro AddressMIB_MULTICASTIPADDRESS_ROW apontado pelo parâmetro Row . Esse erro também será retornado se nenhuma pilha IPv6 estiver no computador local e um endereço IPv6 for especificado no membro Address .
Outros
 Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função GetMulticastIpAddressEntry é definida no Windows Vista e posterior.

A função GetMulticastIpAddressEntry é usada para recuperar uma entrada de estrutura de MIB_MULTICASTIPADDRESS_ROW existente.

Na entrada, o membro Address na estrutura MIB_MULTICASTIPADDRESS_ROW apontada pelo parâmetro Row deve ser inicializado para um endereço IPv4 ou IPv6 multicast válido e família. Além disso, pelo menos um dos seguintes membros na estrutura MIB_MULTICASTIPADDRESS_ROW apontado para o parâmetro Row deve ser inicializado: InterfaceLuid ou InterfaceIndex.

Os campos são usados na ordem listada acima. Portanto, se InterfaceLuid for especificado, esse membro será usado para determinar a interface. Se nenhum valor for definido para o membro InterfaceLuid (o valor desse membro é definido como zero), o membro InterfaceIndex será usado em seguida para determinar a interface.

Na saída quando a chamada é bem-sucedida, GetMulticastIpAddressEntry recupera as outras propriedades para o endereço IP multicast e preenche a estrutura MIB_MULTICASTIPADDRESS_ROW apontada pelo parâmetro Row .

A função GetMulticastIpAddressTable pode ser chamada para enumerar as entradas de endereço IP multicast em um computador local.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho netioapi.h (inclua Iphlpapi.h)
Biblioteca Iphlpapi.lib
DLL Iphlpapi.dll

Confira também

GetMulticastIpAddressTable

MIB_MULTICASTIPADDRESS_ROW

MIB_MULTICASTIPADDRESS_TABLE