WSAJoinLeaf

関数

マルチポイントセッションにリーフノードとして参加する。

DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

SOCKET WSAJoinLeaf(
    SOCKET s,
    const SOCKADDR* name,
    INT namelen,
    WSABUF* lpCallerData,   // optional
    WSABUF* lpCalleeData,   // optional
    QOS* lpSQOS,   // optional
    QOS* lpGQOS,   // optional
    DWORD dwFlags
);

パラメーター

名前	型	方向
s	SOCKET	in
name	SOCKADDR*	in
namelen	INT	in
lpCallerData	WSABUF*	inoptional
lpCalleeData	WSABUF*	outoptional
lpSQOS	QOS*	inoptional
lpGQOS	QOS*	inoptional
dwFlags	DWORD	in

戻り値の型: SOCKET

各言語での呼び出し定義

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

SOCKET WSAJoinLeaf(
    SOCKET s,
    const SOCKADDR* name,
    INT namelen,
    WSABUF* lpCallerData,   // optional
    WSABUF* lpCalleeData,   // optional
    QOS* lpSQOS,   // optional
    QOS* lpGQOS,   // optional
    DWORD dwFlags
);

[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern UIntPtr WSAJoinLeaf(
    UIntPtr s,   // SOCKET
    IntPtr name,   // SOCKADDR*
    int namelen,   // INT
    IntPtr lpCallerData,   // WSABUF* optional
    IntPtr lpCalleeData,   // WSABUF* optional, out
    IntPtr lpSQOS,   // QOS* optional
    IntPtr lpGQOS,   // QOS* optional
    uint dwFlags   // DWORD
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAJoinLeaf(
    s As UIntPtr,   ' SOCKET
    name As IntPtr,   ' SOCKADDR*
    namelen As Integer,   ' INT
    lpCallerData As IntPtr,   ' WSABUF* optional
    lpCalleeData As IntPtr,   ' WSABUF* optional, out
    lpSQOS As IntPtr,   ' QOS* optional
    lpGQOS As IntPtr,   ' QOS* optional
    dwFlags As UInteger   ' DWORD
) As UIntPtr
End Function

' s : SOCKET
' name : SOCKADDR*
' namelen : INT
' lpCallerData : WSABUF* optional
' lpCalleeData : WSABUF* optional, out
' lpSQOS : QOS* optional
' lpGQOS : QOS* optional
' dwFlags : DWORD
Declare PtrSafe Function WSAJoinLeaf Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal name As LongPtr, _
    ByVal namelen As Long, _
    ByVal lpCallerData As LongPtr, _
    ByVal lpCalleeData As LongPtr, _
    ByVal lpSQOS As LongPtr, _
    ByVal lpGQOS As LongPtr, _
    ByVal dwFlags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSAJoinLeaf = ctypes.windll.ws2_32.WSAJoinLeaf
WSAJoinLeaf.restype = ctypes.c_size_t
WSAJoinLeaf.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_void_p,  # name : SOCKADDR*
    ctypes.c_int,  # namelen : INT
    ctypes.c_void_p,  # lpCallerData : WSABUF* optional
    ctypes.c_void_p,  # lpCalleeData : WSABUF* optional, out
    ctypes.c_void_p,  # lpSQOS : QOS* optional
    ctypes.c_void_p,  # lpGQOS : QOS* optional
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAJoinLeaf = Fiddle::Function.new(
  lib['WSAJoinLeaf'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    Fiddle::TYPE_VOIDP,  # name : SOCKADDR*
    Fiddle::TYPE_INT,  # namelen : INT
    Fiddle::TYPE_VOIDP,  # lpCallerData : WSABUF* optional
    Fiddle::TYPE_VOIDP,  # lpCalleeData : WSABUF* optional, out
    Fiddle::TYPE_VOIDP,  # lpSQOS : QOS* optional
    Fiddle::TYPE_VOIDP,  # lpGQOS : QOS* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_UINTPTR_T)

#[link(name = "ws2_32")]
extern "system" {
    fn WSAJoinLeaf(
        s: usize,  // SOCKET
        name: *const SOCKADDR,  // SOCKADDR*
        namelen: i32,  // INT
        lpCallerData: *mut WSABUF,  // WSABUF* optional
        lpCalleeData: *mut WSABUF,  // WSABUF* optional, out
        lpSQOS: *mut QOS,  // QOS* optional
        lpGQOS: *mut QOS,  // QOS* optional
        dwFlags: u32  // DWORD
    ) -> usize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern UIntPtr WSAJoinLeaf(UIntPtr s, IntPtr name, int namelen, IntPtr lpCallerData, IntPtr lpCalleeData, IntPtr lpSQOS, IntPtr lpGQOS, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAJoinLeaf' -Namespace Win32 -PassThru
# $api::WSAJoinLeaf(s, name, namelen, lpCallerData, lpCalleeData, lpSQOS, lpGQOS, dwFlags)

#uselib "WS2_32.dll"
#func global WSAJoinLeaf "WSAJoinLeaf" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WSAJoinLeaf s, varptr(name), namelen, varptr(lpCallerData), varptr(lpCalleeData), varptr(lpSQOS), varptr(lpGQOS), dwFlags   ; 戻り値は stat
; s : SOCKET -> "sptr"
; name : SOCKADDR* -> "sptr"
; namelen : INT -> "sptr"
; lpCallerData : WSABUF* optional -> "sptr"
; lpCalleeData : WSABUF* optional, out -> "sptr"
; lpSQOS : QOS* optional -> "sptr"
; lpGQOS : QOS* optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSAJoinLeaf "WSAJoinLeaf" sptr, var, int, var, var, var, var, int
; res = WSAJoinLeaf(s, name, namelen, lpCallerData, lpCalleeData, lpSQOS, lpGQOS, dwFlags)
; s : SOCKET -> "sptr"
; name : SOCKADDR* -> "var"
; namelen : INT -> "int"
; lpCallerData : WSABUF* optional -> "var"
; lpCalleeData : WSABUF* optional, out -> "var"
; lpSQOS : QOS* optional -> "var"
; lpGQOS : QOS* optional -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSAJoinLeaf "WSAJoinLeaf" sptr, sptr, int, sptr, sptr, sptr, sptr, int
; res = WSAJoinLeaf(s, varptr(name), namelen, varptr(lpCallerData), varptr(lpCalleeData), varptr(lpSQOS), varptr(lpGQOS), dwFlags)
; s : SOCKET -> "sptr"
; name : SOCKADDR* -> "sptr"
; namelen : INT -> "int"
; lpCallerData : WSABUF* optional -> "sptr"
; lpCalleeData : WSABUF* optional, out -> "sptr"
; lpSQOS : QOS* optional -> "sptr"
; lpGQOS : QOS* optional -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; SOCKET WSAJoinLeaf(SOCKET s, SOCKADDR* name, INT namelen, WSABUF* lpCallerData, WSABUF* lpCalleeData, QOS* lpSQOS, QOS* lpGQOS, DWORD dwFlags)
#uselib "WS2_32.dll"
#cfunc global WSAJoinLeaf "WSAJoinLeaf" intptr, var, int, var, var, var, var, int
; res = WSAJoinLeaf(s, name, namelen, lpCallerData, lpCalleeData, lpSQOS, lpGQOS, dwFlags)
; s : SOCKET -> "intptr"
; name : SOCKADDR* -> "var"
; namelen : INT -> "int"
; lpCallerData : WSABUF* optional -> "var"
; lpCalleeData : WSABUF* optional, out -> "var"
; lpSQOS : QOS* optional -> "var"
; lpGQOS : QOS* optional -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; SOCKET WSAJoinLeaf(SOCKET s, SOCKADDR* name, INT namelen, WSABUF* lpCallerData, WSABUF* lpCalleeData, QOS* lpSQOS, QOS* lpGQOS, DWORD dwFlags)
#uselib "WS2_32.dll"
#cfunc global WSAJoinLeaf "WSAJoinLeaf" intptr, intptr, int, intptr, intptr, intptr, intptr, int
; res = WSAJoinLeaf(s, varptr(name), namelen, varptr(lpCallerData), varptr(lpCalleeData), varptr(lpSQOS), varptr(lpGQOS), dwFlags)
; s : SOCKET -> "intptr"
; name : SOCKADDR* -> "intptr"
; namelen : INT -> "int"
; lpCallerData : WSABUF* optional -> "intptr"
; lpCalleeData : WSABUF* optional, out -> "intptr"
; lpSQOS : QOS* optional -> "intptr"
; lpGQOS : QOS* optional -> "intptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSAJoinLeaf = ws2_32.NewProc("WSAJoinLeaf")
)

// s (SOCKET), name (SOCKADDR*), namelen (INT), lpCallerData (WSABUF* optional), lpCalleeData (WSABUF* optional, out), lpSQOS (QOS* optional), lpGQOS (QOS* optional), dwFlags (DWORD)
r1, _, err := procWSAJoinLeaf.Call(
	uintptr(s),
	uintptr(name),
	uintptr(namelen),
	uintptr(lpCallerData),
	uintptr(lpCalleeData),
	uintptr(lpSQOS),
	uintptr(lpGQOS),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // SOCKET

function WSAJoinLeaf(
  s: NativeUInt;   // SOCKET
  name: Pointer;   // SOCKADDR*
  namelen: Integer;   // INT
  lpCallerData: Pointer;   // WSABUF* optional
  lpCalleeData: Pointer;   // WSABUF* optional, out
  lpSQOS: Pointer;   // QOS* optional
  lpGQOS: Pointer;   // QOS* optional
  dwFlags: DWORD   // DWORD
): NativeUInt; stdcall;
  external 'WS2_32.dll' name 'WSAJoinLeaf';

result := DllCall("WS2_32\WSAJoinLeaf"
    , "UPtr", s   ; SOCKET
    , "Ptr", name   ; SOCKADDR*
    , "Int", namelen   ; INT
    , "Ptr", lpCallerData   ; WSABUF* optional
    , "Ptr", lpCalleeData   ; WSABUF* optional, out
    , "Ptr", lpSQOS   ; QOS* optional
    , "Ptr", lpGQOS   ; QOS* optional
    , "UInt", dwFlags   ; DWORD
    , "UPtr")   ; return: SOCKET

●WSAJoinLeaf(s, name, namelen, lpCallerData, lpCalleeData, lpSQOS, lpGQOS, dwFlags) = DLL("WS2_32.dll", "int WSAJoinLeaf(int, void*, int, void*, void*, void*, void*, dword)")
# 呼び出し: WSAJoinLeaf(s, name, namelen, lpCallerData, lpCalleeData, lpSQOS, lpGQOS, dwFlags)
# s : SOCKET -> "int"
# name : SOCKADDR* -> "void*"
# namelen : INT -> "int"
# lpCallerData : WSABUF* optional -> "void*"
# lpCalleeData : WSABUF* optional, out -> "void*"
# lpSQOS : QOS* optional -> "void*"
# lpGQOS : QOS* optional -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。