WSASendMsg

関数

メッセージ構造体を用いてデータを送信する。

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

シグネチャ

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

INT WSASendMsg(
    SOCKET Handle,
    WSAMSG* lpMsg,
    DWORD dwFlags,
    DWORD* lpNumberOfBytesSent,   // optional
    OVERLAPPED* lpOverlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);

パラメーター

名前	型	方向	説明
Handle	SOCKET	in	データを送信する対象のソケット。
lpMsg	WSAMSG*	in	送信内容と宛先・制御情報を保持するWSAMSG構造体へのポインタ。
dwFlags	DWORD	in	送信動作を制御するフラグ。通常は0。
lpNumberOfBytesSent	DWORD*	outoptional	送信されたバイト数を受け取るポインタ。同期完了時に使用。
lpOverlapped	OVERLAPPED*	inoutoptional	オーバーラップ操作に使うOVERLAPPED構造体へのポインタ。同期時はNULL。
lpCompletionRoutine	LPWSAOVERLAPPED_COMPLETION_ROUTINE	inoptional	操作完了時に呼ばれる完了ルーチンへのポインタ。NULL可。

戻り値の型: INT

各言語での呼び出し定義

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

INT WSASendMsg(
    SOCKET Handle,
    WSAMSG* lpMsg,
    DWORD dwFlags,
    DWORD* lpNumberOfBytesSent,   // optional
    OVERLAPPED* lpOverlapped,   // optional
    LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);

[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSASendMsg(
    UIntPtr Handle,   // SOCKET
    IntPtr lpMsg,   // WSAMSG*
    uint dwFlags,   // DWORD
    IntPtr lpNumberOfBytesSent,   // DWORD* optional, out
    IntPtr lpOverlapped,   // OVERLAPPED* optional, in/out
    IntPtr lpCompletionRoutine   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSASendMsg(
    Handle As UIntPtr,   ' SOCKET
    lpMsg As IntPtr,   ' WSAMSG*
    dwFlags As UInteger,   ' DWORD
    lpNumberOfBytesSent As IntPtr,   ' DWORD* optional, out
    lpOverlapped As IntPtr,   ' OVERLAPPED* optional, in/out
    lpCompletionRoutine As IntPtr   ' LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
) As Integer
End Function

' Handle : SOCKET
' lpMsg : WSAMSG*
' dwFlags : DWORD
' lpNumberOfBytesSent : DWORD* optional, out
' lpOverlapped : OVERLAPPED* optional, in/out
' lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function WSASendMsg Lib "ws2_32" ( _
    ByVal Handle As LongPtr, _
    ByVal lpMsg As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal lpNumberOfBytesSent As LongPtr, _
    ByVal lpOverlapped As LongPtr, _
    ByVal lpCompletionRoutine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSASendMsg = ctypes.windll.ws2_32.WSASendMsg
WSASendMsg.restype = ctypes.c_int
WSASendMsg.argtypes = [
    ctypes.c_size_t,  # Handle : SOCKET
    ctypes.c_void_p,  # lpMsg : WSAMSG*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfBytesSent : DWORD* optional, out
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional, in/out
    ctypes.c_void_p,  # lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSASendMsg = Fiddle::Function.new(
  lib['WSASendMsg'],
  [
    Fiddle::TYPE_UINTPTR_T,  # Handle : SOCKET
    Fiddle::TYPE_VOIDP,  # lpMsg : WSAMSG*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpNumberOfBytesSent : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn WSASendMsg(
        Handle: usize,  // SOCKET
        lpMsg: *mut WSAMSG,  // WSAMSG*
        dwFlags: u32,  // DWORD
        lpNumberOfBytesSent: *mut u32,  // DWORD* optional, out
        lpOverlapped: *mut OVERLAPPED,  // OVERLAPPED* optional, in/out
        lpCompletionRoutine: *const core::ffi::c_void  // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int WSASendMsg(UIntPtr Handle, IntPtr lpMsg, uint dwFlags, IntPtr lpNumberOfBytesSent, IntPtr lpOverlapped, IntPtr lpCompletionRoutine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSASendMsg' -Namespace Win32 -PassThru
# $api::WSASendMsg(Handle, lpMsg, dwFlags, lpNumberOfBytesSent, lpOverlapped, lpCompletionRoutine)

#uselib "WS2_32.dll"
#func global WSASendMsg "WSASendMsg" sptr, sptr, sptr, sptr, sptr, sptr
; WSASendMsg Handle, varptr(lpMsg), dwFlags, varptr(lpNumberOfBytesSent), varptr(lpOverlapped), lpCompletionRoutine   ; 戻り値は stat
; Handle : SOCKET -> "sptr"
; lpMsg : WSAMSG* -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpNumberOfBytesSent : DWORD* optional, out -> "sptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr"
; lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSASendMsg "WSASendMsg" sptr, var, int, var, var, sptr
; res = WSASendMsg(Handle, lpMsg, dwFlags, lpNumberOfBytesSent, lpOverlapped, lpCompletionRoutine)
; Handle : SOCKET -> "sptr"
; lpMsg : WSAMSG* -> "var"
; dwFlags : DWORD -> "int"
; lpNumberOfBytesSent : DWORD* optional, out -> "var"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSASendMsg "WSASendMsg" sptr, sptr, int, sptr, sptr, sptr
; res = WSASendMsg(Handle, varptr(lpMsg), dwFlags, varptr(lpNumberOfBytesSent), varptr(lpOverlapped), lpCompletionRoutine)
; Handle : SOCKET -> "sptr"
; lpMsg : WSAMSG* -> "sptr"
; dwFlags : DWORD -> "int"
; lpNumberOfBytesSent : DWORD* optional, out -> "sptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr"
; lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; INT WSASendMsg(SOCKET Handle, WSAMSG* lpMsg, DWORD dwFlags, DWORD* lpNumberOfBytesSent, OVERLAPPED* lpOverlapped, LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine)
#uselib "WS2_32.dll"
#cfunc global WSASendMsg "WSASendMsg" intptr, var, int, var, var, intptr
; res = WSASendMsg(Handle, lpMsg, dwFlags, lpNumberOfBytesSent, lpOverlapped, lpCompletionRoutine)
; Handle : SOCKET -> "intptr"
; lpMsg : WSAMSG* -> "var"
; dwFlags : DWORD -> "int"
; lpNumberOfBytesSent : DWORD* optional, out -> "var"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT WSASendMsg(SOCKET Handle, WSAMSG* lpMsg, DWORD dwFlags, DWORD* lpNumberOfBytesSent, OVERLAPPED* lpOverlapped, LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine)
#uselib "WS2_32.dll"
#cfunc global WSASendMsg "WSASendMsg" intptr, intptr, int, intptr, intptr, intptr
; res = WSASendMsg(Handle, varptr(lpMsg), dwFlags, varptr(lpNumberOfBytesSent), varptr(lpOverlapped), lpCompletionRoutine)
; Handle : SOCKET -> "intptr"
; lpMsg : WSAMSG* -> "intptr"
; dwFlags : DWORD -> "int"
; lpNumberOfBytesSent : DWORD* optional, out -> "intptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "intptr"
; lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSASendMsg = ws2_32.NewProc("WSASendMsg")
)

// Handle (SOCKET), lpMsg (WSAMSG*), dwFlags (DWORD), lpNumberOfBytesSent (DWORD* optional, out), lpOverlapped (OVERLAPPED* optional, in/out), lpCompletionRoutine (LPWSAOVERLAPPED_COMPLETION_ROUTINE optional)
r1, _, err := procWSASendMsg.Call(
	uintptr(Handle),
	uintptr(lpMsg),
	uintptr(dwFlags),
	uintptr(lpNumberOfBytesSent),
	uintptr(lpOverlapped),
	uintptr(lpCompletionRoutine),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT

function WSASendMsg(
  Handle: NativeUInt;   // SOCKET
  lpMsg: Pointer;   // WSAMSG*
  dwFlags: DWORD;   // DWORD
  lpNumberOfBytesSent: Pointer;   // DWORD* optional, out
  lpOverlapped: Pointer;   // OVERLAPPED* optional, in/out
  lpCompletionRoutine: Pointer   // LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSASendMsg';

result := DllCall("WS2_32\WSASendMsg"
    , "UPtr", Handle   ; SOCKET
    , "Ptr", lpMsg   ; WSAMSG*
    , "UInt", dwFlags   ; DWORD
    , "Ptr", lpNumberOfBytesSent   ; DWORD* optional, out
    , "Ptr", lpOverlapped   ; OVERLAPPED* optional, in/out
    , "Ptr", lpCompletionRoutine   ; LPWSAOVERLAPPED_COMPLETION_ROUTINE optional
    , "Int")   ; return: INT

●WSASendMsg(Handle, lpMsg, dwFlags, lpNumberOfBytesSent, lpOverlapped, lpCompletionRoutine) = DLL("WS2_32.dll", "int WSASendMsg(int, void*, dword, void*, void*, void*)")
# 呼び出し: WSASendMsg(Handle, lpMsg, dwFlags, lpNumberOfBytesSent, lpOverlapped, lpCompletionRoutine)
# Handle : SOCKET -> "int"
# lpMsg : WSAMSG* -> "void*"
# dwFlags : DWORD -> "dword"
# lpNumberOfBytesSent : DWORD* optional, out -> "void*"
# lpOverlapped : OVERLAPPED* optional, in/out -> "void*"
# lpCompletionRoutine : LPWSAOVERLAPPED_COMPLETION_ROUTINE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。