Função GetUdp6Table (iphlpapi.h)

Artigo
02/28/2024

A função GetUdp6Table recupera a tabela de ouvintes UDP (Protocolo de Datagrama do Usuário) IPv6.

Sintaxe

IPHLPAPI_DLL_LINKAGE ULONG GetUdp6Table(
  [out]     PMIB_UDP6TABLE Udp6Table,
  [in, out] PULONG         SizePointer,
  [in]      BOOL           Order
);

Parâmetros

[out] Udp6Table

Um ponteiro para um buffer que recebe a tabela do ouvinte UDP IPv6 como uma estrutura MIB_UDP6TABLE .

[in, out] SizePointer

Na entrada, especifica o tamanho em bytes do buffer apontado pelo parâmetro Udp6Table .

Na saída, se o buffer não for grande o suficiente para manter a tabela de ouvinte retornada, a função definirá esse parâmetro como igual ao tamanho do buffer necessário em bytes.

[in] Order

Um valor booliano que especifica se a tabela de ouvinte UDP retornada deve ser classificada. Se esse parâmetro for TRUE, a tabela será classificada na ordem de:

Endereço IPv6 local
ID do escopo local
Porta local

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_INSUFFICIENT_BUFFER	O buffer apontado pelo parâmetro Udp6Table não é grande o suficiente. O tamanho necessário é retornado na variável ULONG apontada pelo parâmetro SizePointer .
ERROR_INVALID_PARAMETER	O parâmetro SizePointer é NULL ou GetUdp6Table não pode gravar na memória apontada pelo parâmetro SizePointer .
ERROR_NOT_SUPPORTED	Não há suporte para essa função no sistema operacional em uso no sistema local.
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

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

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	iphlpapi.h
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll