ホーム › Networking.WindowsWebServices › WsSendMessage

WsSendMessage

関数

チャネル経由でメッセージを送信する。

DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsSendMessage(
    WS_CHANNEL* channel,
    WS_MESSAGE* message,
    const WS_MESSAGE_DESCRIPTION* messageDescription,
    WS_WRITE_OPTION writeOption,
    const void* bodyValue,   // optional
    DWORD bodyValueSize,
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

パラメーター

名前	型	方向
channel	WS_CHANNEL*	in
message	WS_MESSAGE*	in
messageDescription	WS_MESSAGE_DESCRIPTION*	in
writeOption	WS_WRITE_OPTION	in
bodyValue	void*	inoptional
bodyValueSize	DWORD	in
asyncContext	WS_ASYNC_CONTEXT*	inoptional
error	WS_ERROR*	inoptional

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsSendMessage(
    WS_CHANNEL* channel,
    WS_MESSAGE* message,
    const WS_MESSAGE_DESCRIPTION* messageDescription,
    WS_WRITE_OPTION writeOption,
    const void* bodyValue,   // optional
    DWORD bodyValueSize,
    const WS_ASYNC_CONTEXT* asyncContext,   // optional
    WS_ERROR* error   // optional
);

[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsSendMessage(
    ref IntPtr channel,   // WS_CHANNEL*
    ref IntPtr message,   // WS_MESSAGE*
    IntPtr messageDescription,   // WS_MESSAGE_DESCRIPTION*
    int writeOption,   // WS_WRITE_OPTION
    IntPtr bodyValue,   // void* optional
    uint bodyValueSize,   // DWORD
    IntPtr asyncContext,   // WS_ASYNC_CONTEXT* optional
    IntPtr error   // WS_ERROR* optional
);

<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsSendMessage(
    ByRef channel As IntPtr,   ' WS_CHANNEL*
    ByRef message As IntPtr,   ' WS_MESSAGE*
    messageDescription As IntPtr,   ' WS_MESSAGE_DESCRIPTION*
    writeOption As Integer,   ' WS_WRITE_OPTION
    bodyValue As IntPtr,   ' void* optional
    bodyValueSize As UInteger,   ' DWORD
    asyncContext As IntPtr,   ' WS_ASYNC_CONTEXT* optional
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function

' channel : WS_CHANNEL*
' message : WS_MESSAGE*
' messageDescription : WS_MESSAGE_DESCRIPTION*
' writeOption : WS_WRITE_OPTION
' bodyValue : void* optional
' bodyValueSize : DWORD
' asyncContext : WS_ASYNC_CONTEXT* optional
' error : WS_ERROR* optional
Declare PtrSafe Function WsSendMessage Lib "webservices" ( _
    ByRef channel As LongPtr, _
    ByRef message As LongPtr, _
    ByVal messageDescription As LongPtr, _
    ByVal writeOption As Long, _
    ByVal bodyValue As LongPtr, _
    ByVal bodyValueSize As Long, _
    ByVal asyncContext As LongPtr, _
    ByVal error As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WsSendMessage = ctypes.windll.webservices.WsSendMessage
WsSendMessage.restype = ctypes.c_int
WsSendMessage.argtypes = [
    ctypes.c_void_p,  # channel : WS_CHANNEL*
    ctypes.c_void_p,  # message : WS_MESSAGE*
    ctypes.c_void_p,  # messageDescription : WS_MESSAGE_DESCRIPTION*
    ctypes.c_int,  # writeOption : WS_WRITE_OPTION
    ctypes.POINTER(None),  # bodyValue : void* optional
    wintypes.DWORD,  # bodyValueSize : DWORD
    ctypes.c_void_p,  # asyncContext : WS_ASYNC_CONTEXT* optional
    ctypes.c_void_p,  # error : WS_ERROR* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('webservices.dll')
WsSendMessage = Fiddle::Function.new(
  lib['WsSendMessage'],
  [
    Fiddle::TYPE_VOIDP,  # channel : WS_CHANNEL*
    Fiddle::TYPE_VOIDP,  # message : WS_MESSAGE*
    Fiddle::TYPE_VOIDP,  # messageDescription : WS_MESSAGE_DESCRIPTION*
    Fiddle::TYPE_INT,  # writeOption : WS_WRITE_OPTION
    Fiddle::TYPE_VOIDP,  # bodyValue : void* optional
    -Fiddle::TYPE_INT,  # bodyValueSize : DWORD
    Fiddle::TYPE_VOIDP,  # asyncContext : WS_ASYNC_CONTEXT* optional
    Fiddle::TYPE_VOIDP,  # error : WS_ERROR* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "webservices")]
extern "system" {
    fn WsSendMessage(
        channel: *mut isize,  // WS_CHANNEL*
        message: *mut isize,  // WS_MESSAGE*
        messageDescription: *const WS_MESSAGE_DESCRIPTION,  // WS_MESSAGE_DESCRIPTION*
        writeOption: i32,  // WS_WRITE_OPTION
        bodyValue: *const (),  // void* optional
        bodyValueSize: u32,  // DWORD
        asyncContext: *const WS_ASYNC_CONTEXT,  // WS_ASYNC_CONTEXT* optional
        error: *mut isize  // WS_ERROR* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("webservices.dll")]
public static extern int WsSendMessage(ref IntPtr channel, ref IntPtr message, IntPtr messageDescription, int writeOption, IntPtr bodyValue, uint bodyValueSize, IntPtr asyncContext, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsSendMessage' -Namespace Win32 -PassThru
# $api::WsSendMessage(channel, message, messageDescription, writeOption, bodyValue, bodyValueSize, asyncContext, error)

#uselib "webservices.dll"
#func global WsSendMessage "WsSendMessage" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WsSendMessage channel, message, varptr(messageDescription), writeOption, bodyValue, bodyValueSize, varptr(asyncContext), error   ; 戻り値は stat
; channel : WS_CHANNEL* -> "sptr"
; message : WS_MESSAGE* -> "sptr"
; messageDescription : WS_MESSAGE_DESCRIPTION* -> "sptr"
; writeOption : WS_WRITE_OPTION -> "sptr"
; bodyValue : void* optional -> "sptr"
; bodyValueSize : DWORD -> "sptr"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "webservices.dll"
#cfunc global WsSendMessage "WsSendMessage" int, int, var, int, sptr, int, var, int
; res = WsSendMessage(channel, message, messageDescription, writeOption, bodyValue, bodyValueSize, asyncContext, error)
; channel : WS_CHANNEL* -> "int"
; message : WS_MESSAGE* -> "int"
; messageDescription : WS_MESSAGE_DESCRIPTION* -> "var"
; writeOption : WS_WRITE_OPTION -> "int"
; bodyValue : void* optional -> "sptr"
; bodyValueSize : DWORD -> "int"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "var"
; error : WS_ERROR* optional -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "webservices.dll"
#cfunc global WsSendMessage "WsSendMessage" int, int, sptr, int, sptr, int, sptr, int
; res = WsSendMessage(channel, message, varptr(messageDescription), writeOption, bodyValue, bodyValueSize, varptr(asyncContext), error)
; channel : WS_CHANNEL* -> "int"
; message : WS_MESSAGE* -> "int"
; messageDescription : WS_MESSAGE_DESCRIPTION* -> "sptr"
; writeOption : WS_WRITE_OPTION -> "int"
; bodyValue : void* optional -> "sptr"
; bodyValueSize : DWORD -> "int"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "sptr"
; error : WS_ERROR* optional -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; HRESULT WsSendMessage(WS_CHANNEL* channel, WS_MESSAGE* message, WS_MESSAGE_DESCRIPTION* messageDescription, WS_WRITE_OPTION writeOption, void* bodyValue, DWORD bodyValueSize, WS_ASYNC_CONTEXT* asyncContext, WS_ERROR* error)
#uselib "webservices.dll"
#cfunc global WsSendMessage "WsSendMessage" int, int, var, int, intptr, int, var, int
; res = WsSendMessage(channel, message, messageDescription, writeOption, bodyValue, bodyValueSize, asyncContext, error)
; channel : WS_CHANNEL* -> "int"
; message : WS_MESSAGE* -> "int"
; messageDescription : WS_MESSAGE_DESCRIPTION* -> "var"
; writeOption : WS_WRITE_OPTION -> "int"
; bodyValue : void* optional -> "intptr"
; bodyValueSize : DWORD -> "int"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "var"
; error : WS_ERROR* optional -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT WsSendMessage(WS_CHANNEL* channel, WS_MESSAGE* message, WS_MESSAGE_DESCRIPTION* messageDescription, WS_WRITE_OPTION writeOption, void* bodyValue, DWORD bodyValueSize, WS_ASYNC_CONTEXT* asyncContext, WS_ERROR* error)
#uselib "webservices.dll"
#cfunc global WsSendMessage "WsSendMessage" int, int, intptr, int, intptr, int, intptr, int
; res = WsSendMessage(channel, message, varptr(messageDescription), writeOption, bodyValue, bodyValueSize, varptr(asyncContext), error)
; channel : WS_CHANNEL* -> "int"
; message : WS_MESSAGE* -> "int"
; messageDescription : WS_MESSAGE_DESCRIPTION* -> "intptr"
; writeOption : WS_WRITE_OPTION -> "int"
; bodyValue : void* optional -> "intptr"
; bodyValueSize : DWORD -> "int"
; asyncContext : WS_ASYNC_CONTEXT* optional -> "intptr"
; error : WS_ERROR* optional -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsSendMessage = webservices.NewProc("WsSendMessage")
)

// channel (WS_CHANNEL*), message (WS_MESSAGE*), messageDescription (WS_MESSAGE_DESCRIPTION*), writeOption (WS_WRITE_OPTION), bodyValue (void* optional), bodyValueSize (DWORD), asyncContext (WS_ASYNC_CONTEXT* optional), error (WS_ERROR* optional)
r1, _, err := procWsSendMessage.Call(
	uintptr(channel),
	uintptr(message),
	uintptr(messageDescription),
	uintptr(writeOption),
	uintptr(bodyValue),
	uintptr(bodyValueSize),
	uintptr(asyncContext),
	uintptr(error),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function WsSendMessage(
  channel: Pointer;   // WS_CHANNEL*
  message: Pointer;   // WS_MESSAGE*
  messageDescription: Pointer;   // WS_MESSAGE_DESCRIPTION*
  writeOption: Integer;   // WS_WRITE_OPTION
  bodyValue: Pointer;   // void* optional
  bodyValueSize: DWORD;   // DWORD
  asyncContext: Pointer;   // WS_ASYNC_CONTEXT* optional
  error: Pointer   // WS_ERROR* optional
): Integer; stdcall;
  external 'webservices.dll' name 'WsSendMessage';

result := DllCall("webservices\WsSendMessage"
    , "Ptr", channel   ; WS_CHANNEL*
    , "Ptr", message   ; WS_MESSAGE*
    , "Ptr", messageDescription   ; WS_MESSAGE_DESCRIPTION*
    , "Int", writeOption   ; WS_WRITE_OPTION
    , "Ptr", bodyValue   ; void* optional
    , "UInt", bodyValueSize   ; DWORD
    , "Ptr", asyncContext   ; WS_ASYNC_CONTEXT* optional
    , "Ptr", error   ; WS_ERROR* optional
    , "Int")   ; return: HRESULT

●WsSendMessage(channel, message, messageDescription, writeOption, bodyValue, bodyValueSize, asyncContext, error) = DLL("webservices.dll", "int WsSendMessage(void*, void*, void*, int, void*, dword, void*, void*)")
# 呼び出し: WsSendMessage(channel, message, messageDescription, writeOption, bodyValue, bodyValueSize, asyncContext, error)
# channel : WS_CHANNEL* -> "void*"
# message : WS_MESSAGE* -> "void*"
# messageDescription : WS_MESSAGE_DESCRIPTION* -> "void*"
# writeOption : WS_WRITE_OPTION -> "int"
# bodyValue : void* optional -> "void*"
# bodyValueSize : DWORD -> "dword"
# asyncContext : WS_ASYNC_CONTEXT* optional -> "void*"
# error : WS_ERROR* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。