GetOwnerModuleFromUdpEntry (Compact 2013)

3/26/2014

This function retrieves data about the module that issued the context bind for a specific IPv4 UDP endpoint in a MIB table row.

Syntax

DWORD GetOwnerModuleFromUdpEntry(
  __in     PMIB_UDPROW_OWNER_MODULE pUdpEntry,
  __in     TCPIP_OWNER_MODULE_INFO_CLASS Class,
  __out    PVOID Buffer,
  __inout  PDWORD pdwSize
);

Parameters

• pUdpEntry
  A pointer to a MIB_UDPROW_OWNER_MODULE structure that contains the IPv4 UDP endpoint entry used to obtain the owner module.

• Class
  A TCPIP_OWNER_MODULE_INFO_CLASS enumeration value that indicates the type of data to obtain regarding the owner module.

• Buffer
  The buffer that contains a TCPIP_OWNER_MODULE_BASIC_INFO structure with the owner module data. The type of data returned in this buffer is indicated by the value of the Class parameter.

  The following structures are used for the data in Buffer when Class is set to the corresponding value.

  Classenumeration value	Bufferdata format
  TCPIP_OWNER_MODULE_BASIC_INFO	TCPIP_OWNER_MODULE_BASIC_INFO

• pdwSize
  The estimated size, in bytes, of the structure returned in Buffer. If this value is set too small, ERROR_INSUFFICIENT_BUFFER is returned by this function, and this field will contain the correct structure size.

Return Value

If the call is successful, the value NO_ERROR is returned. Otherwise, the following error is returned.

Return code	Description
ERROR_INSUFFICIENT_BUFFER	Insufficient space was allocated for the table. The size of the table is returned in the pdwSize parameter, and must be used in a subsequent call to this function in order to successfully retrieve the table.

Remarks

Buffer contains not only a structure with pointers to specific data, for example, pointers to the zero-terminated strings that contain the name and path of the owner module, but also the actual data itself; that is the name and path strings. Therefore, when calculating the buffer size, make sure that you have sufficient space for both the structure and the data the members of the structure point to.

The resolution of TCP table entries to owner modules is a best practice. In several cases, the owner module name returned in the TCPIP_OWNER_MODULE_BASIC_INFO structure can be a process name, such as "svchost.exe", a service name, such as "RPC", or a component name, such as "timer.dll".

See Also

Reference

IP Helper Functions