WSAGetUdpRecvMaxCoalescedSize function (ws2tcpip.h)

Article
10/13/2021

Retrieves the maximum size of a received, coalesced message for a UDP socket.

Syntax

INT WSAGetUdpRecvMaxCoalescedSize(
  [in]  SOCKET Socket,
  [out] DWORD  *MaxCoalescedMsgSize
);

Parameters

[in] Socket

A descriptor that identifies a UDP socket.

[out] MaxCoalescedMsgSize

Type: DWORD*

A pointer to a DWORD. On success, the function sets the DWORD to the maximum coalesced message size used on the socket for UDP receive coalescing.

Return value

On success, the function returns 0. Otherwise, a value of SOCKET_ERROR is returned, and you can retrieve a specific error code by calling WSAGetLastError.

Remarks

UDP receive coalescing is supported through the UDP_RECV_MAX_COALESCED_SIZE socket option. WSAGetUdpRecvMaxCoalescedSize is a type-safe wrapper for getting this socket option, and we recommend it over getsockopt.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 2004 (10.0; Build 19041)
Minimum supported server	Windows Server, version 2004 (10.0; Build 19041)
Target Platform	Windows
Header	ws2tcpip.h
Library	Ws2_32.lib
DLL	Ws2_32.dll

Share via