WSASetFailConnectOnIcmpError 関数 (ws2tcpip.h)

TCP_FAIL_CONNECT_ON_ICMP_ERROR ソケット オプションの状態を設定します。

構文

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

パラメーター

[in] Socket

TCP ソケットを識別する記述子。

[in] Enabled

種類: DWORD

TCP_FAIL_CONNECT_ON_ICMP_ERRORを有効にする必要がある場合は 0 以外の値。それ以外の場合は 0。

戻り値

成功すると、関数は 0 を返します。 それ以外の場合は、 SOCKET_ERROR の値が返され、 WSAGetLastError を呼び出すことで特定のエラー コードを取得できます。

注釈

この機能は、 TCP_FAIL_CONNECT_ON_ICMP_ERROR ソケット オプションを使用してサポートされます。 WSASetFailConnectOnIcmpError は、このソケット オプションを設定するためのタイプ セーフ ラッパーであり、 setsockopt よりも推奨されます。

要件

要件	値
サポートされている最小のクライアント	Windows 10バージョン 2004 (10.0;ビルド 19041)
サポートされている最小のサーバー	Windows Server バージョン 2004 (10.0;ビルド 19041)
対象プラットフォーム	Windows
ヘッダー	ws2tcpip.h
Library	Ws2_32.lib
[DLL]	Ws2_32.dll