Expand Minimize

MIB_UDP6ROW_OWNER_MODULE structure

The MIB_UDP6ROW_OWNER_MODULE structure contains an entry from the User Datagram Protocol (UDP) listener table for IPv6 on the local computer. This entry also also includes any available ownership data and the process ID (PID) that issued the call to the bind function for the UDP endpoint.

Syntax


typedef struct _MIB_UDP6ROW_OWNER_MODULE {
  UCHAR         ucLocalAddr[16];
  DWORD         dwLocalScopeId;
  DWORD         dwLocalPort;
  DWORD         dwOwningPid;
  LARGE_INTEGER liCreateTimestamp;
  union {
    struct {
      int SpecificPortBind  :1;
    };
    int    dwFlags;
  };
  ULONGLONG     OwningModuleInfo[TCPIP_OWNING_MODULE_SIZE];
} MIB_UDP6ROW_OWNER_MODULE, *PMIB_UDP6ROW_OWNER_MODULE;

Members

ucLocalAddr

Type: UCHAR[16]

The IPv6 address of the UDP endpoint on the local computer. This member is stored in a character array in network byte order.

A value of zero indicates a UDP listener willing to accept datagrams for any IP interface associated with the local computer.

dwLocalScopeId

Type: DWORD

The scope ID for the IPv6 address of the UDP endpoint on the local computer.

dwLocalPort

Type: DWORD

The port number for the local UDP endpoint.

dwOwningPid

Type: DWORD

The PID of the process that issued a context bind for this endpoint. If this value is set to 0, the information for this endpoint is unavailable.

liCreateTimestamp

Type: LARGE_INTEGER

A SYSTEMTIME structure that indicates when the context bind operation that created this endpoint occurred.

SpecificPortBind

Type: int

A value that indicates if a specific port was specified in the last context bind operation.

dwFlags

Type: int

A set of flags. This member is not currently used.

OwningModuleInfo

Type: ULONGLONG[TCPIP_OWNING_MODULE_SIZE]

An array of opaque data that contains ownership information.

Remarks

The MIB_UDP6TABLE_OWNER_MODULE structure is returned by a call to GetExtendedUdpTable with the TableClass parameter set to a UDP_TABLE_OWNER_MODULE from the UDP_TABLE_CLASS enumeration and the ulAf parameter set to AF_INET6. The MIB_UDP6TABLE_OWNER_MODULE structure contains an array of MIB_UDP6ROW_OWNER_MODULE structures.

The ucLocalAddr member is stored in a character array in network byte order. On Windows Vista and later, the RtlIpv6AddressToString or RtlIpv6AddressToStringEx functions may be used to convert the IPv6 address in the ucLocalAddr member to a string without loading the Windows Sockets DLL.

The dwLocalScopeId member is in network byte order. In order to use the dwLocalScopeId member, the ntohl or inet_ntoa functions in Windows Sockets or similar functions may be needed.

The dwLocalPort member are in network byte order. In order to use the dwLocalPort member, the ntohs or inet_ntoa functions in Windows Sockets or similar functions may be needed.

The MIB_UDP6TABLE_OWNER_MODULE structure contains the UDP listener table for IPv6 on the local computer. The name is based on the definition of this table in RFC 2454 published by the IETF. For more information, see http://www.ietf.org/rfc/rfc2454.txt. This table contains UDP endpoints for IPv6 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).

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 Vista, Windows XP with SP2 [desktop apps only]

Minimum supported server

Windows Server 2008, Windows Server 2003 with SP1 [desktop apps only]

Header

Udpmib.h on Windows Server 2008 and Windows Vista (include Iphlpapi.h);
Iprtrmib.h on Windows Server 2003 with SP1 and Windows XP with SP2 (include Iphlpapi.h)

See also

bind
GetExtendedUdpTable
inet_ntoa
MIB_UDP6TABLE_OWNER_MODULE
ntohl
ntohs
RtlIpv6AddressToString
RtlIpv6AddressToStringEx
SYSTEMTIME
UDP_TABLE_CLASS

 

 

Community Additions

ADD
Show:
© 2014 Microsoft