Edit

Share via

WSAGetIPUserMtu function (ws2tcpip.h)

  • Article

Retrieves the user-defined IP layer MTU for a socket.

Syntax

INT WSAGetIPUserMtu(
  [in]  SOCKET Socket,
  [out] DWORD  *Mtu
);

Parameters

[in] Socket

A descriptor that identifies a socket.

[out] Mtu

Type: DWORD*

A pointer to a DWORD. On success, the function sets the DWORD to the user-defined IP layer MTU set on the socket.

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

This functionality is supported through the IP_USER_MTU socket option. WSAGetIPUserMtu 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