Edit

Share via

WSAGetRecvIPEcn function (ws2tcpip.h)

  • Article

Queries the current enablement of receiving the IP_ECN (or IPV6_ECN) control message via LPFN_WSARECVMSG (WSARecvMsg). See WSASetRecvIPEcn for more info.

For more info, and code examples, see Winsock explicit congestion notification (ECN).

Syntax

INT WSAGetRecvIPEcn(
  SOCKET Socket,
  DWORD  *Enabled
);

Parameters

Socket

Type: _In_ SOCKET

A descriptor that identifies the socket.

Enabled

Type: _Out_ DWORD*

TRUE if the receipt of ECN codepoints is enabled; otherwise, FALSE.

Return value

If the function succeeds, then the return value is 0. Otherwise, a value of SOCKET_ERROR is returned, and you can retreive a specific error code by calling WSAGetLastError.

Requirements

Requirement Value
Minimum supported client Windows 10 Build 20348
Minimum supported server Windows 10 Build 20348
Header ws2tcpip.h

See also