MIB_UDPTABLE structure

The MIB_UDPTABLE structure contains the User Datagram Protocol (UDP) listener table for IPv4 on the local computer.

Syntax


typedef struct _MIB_UDPTABLE {
  DWORD      dwNumEntries;
  MIB_UDPROW table[ANY_SIZE];
} MIB_UDPTABLE, *PMIB_UDPTABLE;

Members

dwNumEntries

The number of entries in the table.

table

A pointer to an array of MIB_UDPROW structures.

Remarks

The GetUdpTable function enumerates the table of UDP endpoints for IPv4 that have been bound to an address on the local computer and returns this information in a MIB_UDPTABLE structure. This table includes the local IPv4 address and port information for sending and receiving UDP datagrams on the local computer. An array of MIB_UDPROW structures are contained in the MIB_UDPTABLE structure.

The MIB_UDPTABLE structure may contain padding for alignment between the dwNumEntries member and the first MIB_UDPROW array entry in the table member. Padding for alignment may also be present between the MIB_UDPROW array entries in the table member. Any access to a MIB_UDPROW array entry should assume padding may exist.

The MIB_UDPTABLE structure contains the UDP listener table for IPv4 on the local computer. The name is based on the definition of this table in RFC 1213 published by the IETF. For more information, see http://www.ietf.org/rfc/rfc1213.txt. This table contains UDP endpoints for IPv4 that have been bound to an address. It should be noted that an application can create a UDP socket and bind it to an address for the sole purpose of sending a UDP datagram, with no intention of receiving packets using this socket (functioning as a listener).

The MIB_UDPTABLE_OWNER_MODULE structure is an enhanced version of the MIB_UDPTABLE_OWNER_PID structure that includes any available ownership data for each UDP endpoint in the table. The MIB_UDPTABLE_OWNER_PID is an enhanced version of the MIB_UDPTABLE that includes the process ID (PID) that issued the call to the bind function for each UDP endpoint in the table.

On the Microsoft Windows Software Development Kit (SDK) released for Windows Vista and later, the organization of header files has changed. This structure is defined in the Udpmib.h header file, not in the Iprtrmib.h header file. Note that the Udpmib.h header file is automatically included in Iprtrmib.h, which is automatically included in the Iphlpapi.h header file. The Udpmib.h and Iprtrmib.h header files should never be used directly.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Udpmib.h on Windows Server 2008 and Windows Vista (include Iphlpapi.h);
Iprtrmib.h on Windows Server 2003, Windows XP and Windows 2000 (include Iphlpapi.h)

See also

bind
GetExtendedUdpTable
GetUdp6Table
GetUdpTable
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

 

 

Show: