Win32 API 日本語リファレンス
ホームNetworking.WinSock › WSASetSocketPeerTargetName

WSASetSocketPeerTargetName

関数
ソケット通信相手のターゲット名を設定し認証に使用する。
DLLfwpuclnt.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT WSASetSocketPeerTargetName(
    SOCKET Socket,
    const SOCKET_PEER_TARGET_NAME* PeerTargetName,
    DWORD PeerTargetNameLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);

パラメーター

名前方向
SocketSOCKETin
PeerTargetNameSOCKET_PEER_TARGET_NAME*in
PeerTargetNameLenDWORDin
OverlappedOVERLAPPED*inoptional
CompletionRoutineLPWSAOVERLAPPED_COMPLETION_ROUTINEinoptional

戻り値の型: INT

各言語での呼び出し定義

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

INT WSASetSocketPeerTargetName(
    SOCKET Socket,
    const SOCKET_PEER_TARGET_NAME* PeerTargetName,
    DWORD PeerTargetNameLen,
    OVERLAPPED* Overlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine   // optional
);
[DllImport("fwpuclnt.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSASetSocketPeerTargetName(
    UIntPtr Socket,   // SOCKET
    IntPtr PeerTargetName,   // SOCKET_PEER_TARGET_NAME*
    uint PeerTargetNameLen,   // DWORD
    IntPtr Overlapped,   // OVERLAPPED* optional
    IntPtr CompletionRoutine   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
);
<DllImport("fwpuclnt.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSASetSocketPeerTargetName(
    Socket As UIntPtr,   ' SOCKET
    PeerTargetName As IntPtr,   ' SOCKET_PEER_TARGET_NAME*
    PeerTargetNameLen As UInteger,   ' DWORD
    Overlapped As IntPtr,   ' OVERLAPPED* optional
    CompletionRoutine As IntPtr   ' LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
) As Integer
End Function
' Socket : SOCKET
' PeerTargetName : SOCKET_PEER_TARGET_NAME*
' PeerTargetNameLen : DWORD
' Overlapped : OVERLAPPED* optional
' CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function WSASetSocketPeerTargetName Lib "fwpuclnt" ( _
    ByVal Socket As LongPtr, _
    ByVal PeerTargetName As LongPtr, _
    ByVal PeerTargetNameLen 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

WSASetSocketPeerTargetName = ctypes.windll.fwpuclnt.WSASetSocketPeerTargetName
WSASetSocketPeerTargetName.restype = ctypes.c_int
WSASetSocketPeerTargetName.argtypes = [
    ctypes.c_size_t,  # Socket : SOCKET
    ctypes.c_void_p,  # PeerTargetName : SOCKET_PEER_TARGET_NAME*
    wintypes.DWORD,  # PeerTargetNameLen : 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')
WSASetSocketPeerTargetName = Fiddle::Function.new(
  lib['WSASetSocketPeerTargetName'],
  [
    Fiddle::TYPE_UINTPTR_T,  # Socket : SOCKET
    Fiddle::TYPE_VOIDP,  # PeerTargetName : SOCKET_PEER_TARGET_NAME*
    -Fiddle::TYPE_INT,  # PeerTargetNameLen : DWORD
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
    Fiddle::TYPE_VOIDP,  # CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "fwpuclnt")]
extern "system" {
    fn WSASetSocketPeerTargetName(
        Socket: usize,  // SOCKET
        PeerTargetName: *const SOCKET_PEER_TARGET_NAME,  // SOCKET_PEER_TARGET_NAME*
        PeerTargetNameLen: 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 WSASetSocketPeerTargetName(UIntPtr Socket, IntPtr PeerTargetName, uint PeerTargetNameLen, IntPtr Overlapped, IntPtr CompletionRoutine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fwpuclnt_WSASetSocketPeerTargetName' -Namespace Win32 -PassThru
# $api::WSASetSocketPeerTargetName(Socket, PeerTargetName, PeerTargetNameLen, Overlapped, CompletionRoutine)
#uselib "fwpuclnt.dll"
#func global WSASetSocketPeerTargetName "WSASetSocketPeerTargetName" sptr, sptr, sptr, sptr, sptr
; WSASetSocketPeerTargetName Socket, varptr(PeerTargetName), PeerTargetNameLen, varptr(Overlapped), CompletionRoutine   ; 戻り値は stat
; Socket : SOCKET -> "sptr"
; PeerTargetName : SOCKET_PEER_TARGET_NAME* -> "sptr"
; PeerTargetNameLen : DWORD -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "fwpuclnt.dll"
#cfunc global WSASetSocketPeerTargetName "WSASetSocketPeerTargetName" sptr, var, int, var, sptr
; res = WSASetSocketPeerTargetName(Socket, PeerTargetName, PeerTargetNameLen, Overlapped, CompletionRoutine)
; Socket : SOCKET -> "sptr"
; PeerTargetName : SOCKET_PEER_TARGET_NAME* -> "var"
; PeerTargetNameLen : DWORD -> "int"
; Overlapped : OVERLAPPED* optional -> "var"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT WSASetSocketPeerTargetName(SOCKET Socket, SOCKET_PEER_TARGET_NAME* PeerTargetName, DWORD PeerTargetNameLen, OVERLAPPED* Overlapped, LPWSAOVERLAPPED_COMPLETION_ROUTINE CompletionRoutine)
#uselib "fwpuclnt.dll"
#cfunc global WSASetSocketPeerTargetName "WSASetSocketPeerTargetName" intptr, var, int, var, intptr
; res = WSASetSocketPeerTargetName(Socket, PeerTargetName, PeerTargetNameLen, Overlapped, CompletionRoutine)
; Socket : SOCKET -> "intptr"
; PeerTargetName : SOCKET_PEER_TARGET_NAME* -> "var"
; PeerTargetNameLen : DWORD -> "int"
; Overlapped : OVERLAPPED* optional -> "var"
; CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	fwpuclnt = windows.NewLazySystemDLL("fwpuclnt.dll")
	procWSASetSocketPeerTargetName = fwpuclnt.NewProc("WSASetSocketPeerTargetName")
)

// Socket (SOCKET), PeerTargetName (SOCKET_PEER_TARGET_NAME*), PeerTargetNameLen (DWORD), Overlapped (OVERLAPPED* optional), CompletionRoutine (LPWSAOVERLAPPED_COMPLETION_ROUTINE optional)
r1, _, err := procWSASetSocketPeerTargetName.Call(
	uintptr(Socket),
	uintptr(PeerTargetName),
	uintptr(PeerTargetNameLen),
	uintptr(Overlapped),
	uintptr(CompletionRoutine),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSASetSocketPeerTargetName(
  Socket: NativeUInt;   // SOCKET
  PeerTargetName: Pointer;   // SOCKET_PEER_TARGET_NAME*
  PeerTargetNameLen: DWORD;   // DWORD
  Overlapped: Pointer;   // OVERLAPPED* optional
  CompletionRoutine: Pointer   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
): Integer; stdcall;
  external 'fwpuclnt.dll' name 'WSASetSocketPeerTargetName';
result := DllCall("fwpuclnt\WSASetSocketPeerTargetName"
    , "UPtr", Socket   ; SOCKET
    , "Ptr", PeerTargetName   ; SOCKET_PEER_TARGET_NAME*
    , "UInt", PeerTargetNameLen   ; DWORD
    , "Ptr", Overlapped   ; OVERLAPPED* optional
    , "Ptr", CompletionRoutine   ; LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
    , "Int")   ; return: INT
●WSASetSocketPeerTargetName(Socket, PeerTargetName, PeerTargetNameLen, Overlapped, CompletionRoutine) = DLL("fwpuclnt.dll", "int WSASetSocketPeerTargetName(int, void*, dword, void*, void*)")
# 呼び出し: WSASetSocketPeerTargetName(Socket, PeerTargetName, PeerTargetNameLen, Overlapped, CompletionRoutine)
# Socket : SOCKET -> "int"
# PeerTargetName : SOCKET_PEER_TARGET_NAME* -> "void*"
# PeerTargetNameLen : DWORD -> "dword"
# Overlapped : OVERLAPPED* optional -> "void*"
# CompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。