WSASetFailConnectOnIcmpError function (ws2tcpip.h)

Sets the state of the TCP_FAIL_CONNECT_ON_ICMP_ERROR socket option.

Syntax

INT WSASetFailConnectOnIcmpError(
  [in] SOCKET Socket,
  [in] DWORD  Enabled
);

Parameters

[in] Socket

A descriptor that identifies a TCP socket.

[in] Enabled

Type: DWORD

A non-zero value if TCP_FAIL_CONNECT_ON_ICMP_ERROR should be enabled, otherwise zero.

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 TCP_FAIL_CONNECT_ON_ICMP_ERROR socket option. WSASetFailConnectOnIcmpError is a type-safe wrapper for setting this socket option, and we recommend it over setsockopt.

Requirements