GetUdp6Table function (iphlpapi.h)

Article
10/13/2021

The GetUdp6Table function retrieves the IPv6 User Datagram Protocol (UDP) listener table.

Syntax

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

Parameters

[out] Udp6Table

A pointer to a buffer that receives the IPv6 UDP listener table as a MIB_UDP6TABLE structure.

[in, out] SizePointer

On input, specifies the size in bytes of the buffer pointed to by the Udp6Table parameter.

On output, if the buffer is not large enough to hold the returned listener table, the function sets this parameter equal to the required buffer size in bytes.

[in] Order

A Boolean value that specifies whether the returned UDP listener table should be sorted. If this parameter is TRUE, the table is sorted in the order of:

Local IPv6 address
Local scope ID
Local port

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Return code	Description
ERROR_INSUFFICIENT_BUFFER	The buffer pointed to by the Udp6Table parameter is not large enough. The required size is returned in the ULONG variable pointed to by the SizePointer parameter.
ERROR_INVALID_PARAMETER	The SizePointer parameter is NULL, or GetUdp6Table is unable to write to the memory pointed to by the SizePointer parameter.
ERROR_NOT_SUPPORTED	This function is not supported on the operating system in use on the local system.
Other	Use FormatMessage to obtain the message string for the returned error.

Remarks

The GetUdp6Table function is defined on Windows Vista and later.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	iphlpapi.h
Library	Iphlpapi.lib
DLL	Iphlpapi.dll