GetUdpTable function (iphlpapi.h)
The GetUdpTable function retrieves the IPv4 User Datagram Protocol (UDP) listener table.
Syntax
IPHLPAPI_DLL_LINKAGE ULONG GetUdpTable(
[out] PMIB_UDPTABLE UdpTable,
[in, out] PULONG SizePointer,
[in] BOOL Order
);
Parameters
[out] UdpTable
A pointer to a buffer that receives the IPv4 UDP listener table as a MIB_UDPTABLE structure.
[in, out] SizePointer
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.
On the Windows SDK released for Windows Vista and later, the data type for this parameter is changed to a PULONG which is equivalent to a PDWORD.
[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 IP address
- 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 |
|---|---|
|
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. |
|
The pdwSize parameter is NULL, or GetUdpTable is unable to write to the memory pointed to by the pdwSize parameter. |
|
This function is not supported on the operating system in use on the local system. |
|
Use FormatMessage to obtain the message string for the returned error. |
Remarks
On the Windows SDK released for Windows Vista and later, the return value from the GetUdpTable function is changed to a data type of ULONG which is equivalent to a DWORD.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps | UWP apps] |
| Minimum supported server | Windows 2000 Server [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | iphlpapi.h |
| Library | Iphlpapi.lib |
| DLL | Iphlpapi.dll |