WSAGetFailConnectOnIcmpError 関数 (ws2tcpip.h)

  • [アーティクル]

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

構文

INT WSAGetFailConnectOnIcmpError(
  [in]  SOCKET Socket,
  [out] DWORD  *Enabled
);

パラメーター

[in] Socket

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

[out] Enabled

型: DWORD*

DWORD へのポインター。 成功した場合、この関数は、 TCP_FAIL_CONNECT_ON_ICMP_ERROR が有効な場合は DWORD を 0 以外の値に設定し、それ以外の場合は 0 に設定します。

戻り値

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

注釈

この機能は、 TCP_FAIL_CONNECT_ON_ICMP_ERROR ソケット オプションを使用してサポートされます。 WSAGetFailConnectOnIcmpError は、このソケット オプションを取得するためのタイプ セーフ なラッパーであり、 getsockopt よりもこれをお勧めします。

要件

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