Windows Dev Center

Collapse the table of content
Expand the table of content
Expand Minimize

GetUdp6Table function

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

Syntax


ULONG WINAPI GetUdp6Table(
  _Out_   PMIB_UDP6TABLE Udp6Table,
  _Inout_ PULONG         SizePointer,
  _In_    BOOL           Order
);

Parameters

Udp6Table [out]

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

SizePointer [in, out]

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.

Order [in]

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:

  1. Local IPv6 address
  2. Local scope ID
  3. 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 codeDescription
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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Iphlpapi.h

Library

Iphlpapi.lib

DLL

Iphlpapi.dll

See also

GetExtendedUdpTable
GetUdp6Table
GetOwnerModuleFromUdp6Entry
GetOwnerModuleFromUdpEntry
GetUdpStatistics
GetUdpStatisticsEx
MIB_UDP6ROW
MIB_UDP6ROW_OWNER_MODULE
MIB_UDP6ROW_OWNER_PID
MIB_UDP6TABLE
MIB_UDP6TABLE_OWNER_MODULE
MIB_UDP6TABLE_OWNER_PID
MIB_UDPROW
MIB_UDPROW_OWNER_MODULE
MIB_UDPROW_OWNER_PID
MIB_UDPTABLE_OWNER_MODULE
MIB_UDPTABLE_OWNER_PID
MIB_UDPTABLE

 

 

Community Additions

ADD
Show:
© 2015 Microsoft