ホーム › Networking.WinSock › WSADeleteSocketPeerTargetName

WSADeleteSocketPeerTargetName

関数

ソケットに設定したピアのターゲット名を削除する。

DLLfwpuclnt.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// fwpuclnt.dll
#include <windows.h>

INT WSADeleteSocketPeerTargetName(
    SOCKET Socket,
    const SOCKADDR* PeerAddr,
    DWORD PeerAddrLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);

パラメーター

名前	型	方向	説明
Socket	SOCKET	in	ピアのターゲット名を削除する対象のソケットを識別する記述子です。
PeerAddr	SOCKADDR*	in	ターゲット名を削除する対象となるピアの IP アドレスです。
PeerAddrLen	DWORD	in	PeerAddr パラメーターのサイズ (バイト単位) です。
Overlapped	OVERLAPPED*	inoptional	WSAOVERLAPPED 構造体へのポインターです。このパラメーターは、オーバーラップしないソケットでは無視されます。
CompletionRoutine	LPWSAOVERLAPPED_COMPLETION_ROUTINE	inoptional	操作の完了時に呼び出される完了ルーチンへのポインターです。このパラメーターは、オーバーラップしないソケットでは無視されます。

戻り値の型: INT

公式ドキュメント

ソケットについて、ピアのターゲット名と IP アドレスの関連付けを削除します。正常に復帰した後は、その IP アドレスとターゲット名の間に今後の関連付けは存在しなくなります。

戻り値

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

発生し得るエラーコードの一部を以下に示します。

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

解説(Remarks)

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 のいずれかである必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// fwpuclnt.dll
#include <windows.h>

INT WSADeleteSocketPeerTargetName(
    SOCKET Socket,
    const SOCKADDR* PeerAddr,
    DWORD PeerAddrLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);

[DllImport("fwpuclnt.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSADeleteSocketPeerTargetName(
    UIntPtr Socket,   // SOCKET
    IntPtr PeerAddr,   // SOCKADDR*
    uint PeerAddrLen,   // DWORD
    IntPtr Overlapped,   // OVERLAPPED* optional
    IntPtr CompletionRoutine   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
);

<DllImport("fwpuclnt.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSADeleteSocketPeerTargetName(
    Socket As UIntPtr,   ' SOCKET
    PeerAddr As IntPtr,   ' SOCKADDR*
    PeerAddrLen As UInteger,   ' DWORD
    Overlapped As IntPtr,   ' OVERLAPPED* optional
    CompletionRoutine As IntPtr   ' LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
) As Integer
End Function

' Socket : SOCKET
' PeerAddr : SOCKADDR*
' PeerAddrLen : DWORD
' Overlapped : OVERLAPPED* optional
' CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function WSADeleteSocketPeerTargetName Lib "fwpuclnt" ( _
    ByVal Socket As LongPtr, _
    ByVal PeerAddr As LongPtr, _
    ByVal PeerAddrLen As Long, _
    ByVal Overlapped As LongPtr, _
    ByVal CompletionRoutine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSADeleteSocketPeerTargetName = ctypes.windll.fwpuclnt.WSADeleteSocketPeerTargetName
WSADeleteSocketPeerTargetName.restype = ctypes.c_int
WSADeleteSocketPeerTargetName.argtypes = [
    ctypes.c_size_t,  # Socket : SOCKET
    ctypes.c_void_p,  # PeerAddr : SOCKADDR*
    wintypes.DWORD,  # PeerAddrLen : DWORD
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional
    ctypes.c_void_p,  # CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('fwpuclnt.dll')
WSADeleteSocketPeerTargetName = Fiddle::Function.new(
  lib['WSADeleteSocketPeerTargetName'],
  [
    Fiddle::TYPE_UINTPTR_T,  # Socket : SOCKET
    Fiddle::TYPE_VOIDP,  # PeerAddr : SOCKADDR*
    -Fiddle::TYPE_INT,  # PeerAddrLen : DWORD
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
    Fiddle::TYPE_VOIDP,  # CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "fwpuclnt")]
extern "system" {
    fn WSADeleteSocketPeerTargetName(
        Socket: usize,  // SOCKET
        PeerAddr: *const SOCKADDR,  // SOCKADDR*
        PeerAddrLen: u32,  // DWORD
        Overlapped: *mut OVERLAPPED,  // OVERLAPPED* optional
        CompletionRoutine: *const core::ffi::c_void  // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("fwpuclnt.dll", SetLastError = true)]
public static extern int WSADeleteSocketPeerTargetName(UIntPtr Socket, IntPtr PeerAddr, uint PeerAddrLen, IntPtr Overlapped, IntPtr CompletionRoutine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_WSADeleteSocketPeerTargetName' -Namespace Win32 -PassThru
# $api::WSADeleteSocketPeerTargetName(Socket, PeerAddr, PeerAddrLen, Overlapped, CompletionRoutine)

#uselib "fwpuclnt.dll"
#func global WSADeleteSocketPeerTargetName "WSADeleteSocketPeerTargetName" sptr, sptr, sptr, sptr, sptr
; WSADeleteSocketPeerTargetName Socket, varptr(PeerAddr), PeerAddrLen, varptr(Overlapped), CompletionRoutine   ; 戻り値は stat
; Socket : SOCKET -> "sptr"
; PeerAddr : SOCKADDR* -> "sptr"
; PeerAddrLen : DWORD -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "fwpuclnt.dll"
#cfunc global WSADeleteSocketPeerTargetName "WSADeleteSocketPeerTargetName" sptr, var, int, var, sptr
; res = WSADeleteSocketPeerTargetName(Socket, PeerAddr, PeerAddrLen, Overlapped, CompletionRoutine)
; Socket : SOCKET -> "sptr"
; PeerAddr : SOCKADDR* -> "var"
; PeerAddrLen : DWORD -> "int"
; Overlapped : OVERLAPPED* optional -> "var"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "fwpuclnt.dll"
#cfunc global WSADeleteSocketPeerTargetName "WSADeleteSocketPeerTargetName" sptr, sptr, int, sptr, sptr
; res = WSADeleteSocketPeerTargetName(Socket, varptr(PeerAddr), PeerAddrLen, varptr(Overlapped), CompletionRoutine)
; Socket : SOCKET -> "sptr"
; PeerAddr : SOCKADDR* -> "sptr"
; PeerAddrLen : DWORD -> "int"
; Overlapped : OVERLAPPED* optional -> "sptr"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。