Função GetUdpTable (iphlpapi.h)

Artigo
08/24/2023

A função GetUdpTable recupera a tabela de ouvintes UDP (Protocolo de Datagrama de Usuário) IPv4.

Sintaxe

IPHLPAPI_DLL_LINKAGE ULONG GetUdpTable(
  [out]     PMIB_UDPTABLE UdpTable,
  [in, out] PULONG        SizePointer,
  [in]      BOOL          Order
);

Parâmetros

[out] UdpTable

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

[in, out] SizePointer

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

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.

No SDK do Windows lançado para Windows Vista e posterior, o tipo de dados desse parâmetro é alterado para um PULONG que é equivalente a um PDWORD.

[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 IP local
Porta local

Valor retornado

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 pUdpTable não é grande o suficiente. O tamanho necessário é retornado na variável ULONG apontada pelo parâmetro pdwSize . Esse erro também será retornado se o parâmetro pUdpTable for NULL.
ERROR_INVALID_PARAMETER	O parâmetro pdwSize é NULL ou GetUdpTable não pode gravar na memória apontada pelo parâmetro pdwSize .
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

No SDK do Windows lançado para Windows Vista e posterior, o valor retornado da função GetUdpTable é alterado para um tipo de dados ULONG que é equivalente a um DWORD.

Requisitos


Cliente mínimo com suporte	Windows 2000 Professional [aplicativos da área de trabalho \| Aplicativos UWP]
Servidor mínimo com suporte	Windows 2000 Server [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	iphlpapi.h
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll