GetUdpTable (Compact 2013)

3/26/2014

This function retrieves the User Datagram Protocol (UDP) listener table.

Syntax

DWORD GetUdpTable(
  PMIB_UDPTABLE pUdpTable, 
  PDWORD pdwSize, 
  BOOL bOrder 
);

pUdpTable
[out] A pointer to a buffer that receives the IPv4 UDP listener table as a MIB_UDPTABLE structure.

pdwSize
[in, out] On input, specifies the size in bytes of the buffer pointed to by the UdpTable 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.

bOrder
[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 IP address
2. Local port

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 pUdpTable parameter is not large enough. The required size is returned in the ULONG variable pointed to by the pdwSize parameter. This error is also returned if the pUdpTable parameter is NULL.
ERROR_INVALID_PARAMETER	The pdwSize parameter is NULL, or GetUdpTable is unable to write to the memory pointed to by the pdwSize parameter.
ERROR_NOT_SUPPORTED	This function is not supported on the operating system that is used on the local system.
Other	Use FormatMessage to obtain the message string for the returned error.

Header	iphlpapi.h
Library	Iphlpapi.lib