WSADeleteSocketPeerTargetName 関数 (ws2tcpip.h)

[アーティクル]
08/28/2023

WSADeleteSocketPeerTargetName 関数は、ピアターゲット名とソケットの IP アドレスの間の関連付けを削除します。正常に戻った後は、IP アドレスとターゲット名の間に今後の関連付けはありません。

構文

INT WSAAPI WSADeleteSocketPeerTargetName(
  [in]           SOCKET                             Socket,
  [in]           const sockaddr                     *PeerAddr,
  [in]           ULONG                              PeerAddrLen,
  [in, optional] LPWSAOVERLAPPED                    Overlapped,
  [in, optional] LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine
);

パラメーター

[in] Socket

ピアターゲット名が削除されるソケットを識別する記述子。

[in] PeerAddr

ターゲット名が削除されるピアの IP アドレス。

[in] PeerAddrLen

PeerAddr パラメーターのサイズ (バイト単位)。

[in, optional] Overlapped

WSAOVERLAPPED 構造体へのポインター。このパラメーターは、重複していないソケットでは無視されます。

[in, optional] CompletionRoutine

操作が完了したときに呼び出される完了ルーチンへのポインター。このパラメーターは、重複していないソケットでは無視されます。

戻り値

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

考えられるエラーコードを次に示します。

エラーコード	意味
WSAEAFNOSUPPORT	指定されたアドレスファミリはサポートされていません。
WSAEFAULT	システムは、呼び出しのポインター引数を使用しようとしたときに、無効なアドレスポインターを検出しました。 PeerAddr パラメーターが NULL ポインターの場合、このエラーが返されます。
WSAEINVAL	無効なパラメーターが渡されました。 Socket パラメーターで渡されたソケットが、AF_INETまたはAF_INET6のアドレスファミリと、SOCK_DGRAMまたはSOCK_STREAMのソケットの種類で作成されていない場合、このエラーが返されます。
WSAEMSGSIZE	渡されたバッファーが小さすぎます。
WSAENOTSOCK	Socket パラメーターで渡された記述子が有効なソケットではありません。

注釈

WSADeleteSocketPeerTargetName 関数は、ピアターゲット名とソケットの IP アドレスの間の関連付けを削除するメソッドを提供します。この関数は、 WSASetSocketPeerTargetName 関数で以前に設定されたピアターゲット名を削除するために使用されます。 WSADeleteSocketPeerTargetName 関数が返された後、IP アドレスに対する今後の認証では、以前に指定したターゲット名は使用されません。この関数は、主にコネクションレスクライアント (たとえば、型が SOCK_DGRAM に設定されたソケット、またはプロトコルが IPPROTO_UDP に設定されたソケット) が、ピアターゲット名に関連付けられた IP アドレスで接続を終了した後に使用するように設計されています。接続指向クライアント (たとえば、型を SOCK_STREAM に設定して作成されたソケット、またはプロトコルを IPPROTO_TCP に設定) の場合、この関数は呼び出さないでください。

WSADeleteSocketPeerTargetName 関数を使用すると、dwIoControlCode パラメーターを SIO_DELETE_PEER_TARGET_NAME に設定して WSAIoctl 関数を呼び出す必要が簡単になります。

次の条件が満たされない場合、エラーが返されます。

Socket パラメーターのアドレスファミリは、AF_INETまたはAF_INET6である必要があります。
ソケットの種類は、SOCK_STREAMまたはSOCK_DGRAMである必要があります。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	ws2tcpip.h
Library	Fwpuclnt.lib
[DLL]	Fwpuclnt.dll