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

WsCreateMessageForChannel

関数
チャネルに適合したメッセージを作成する。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT WsCreateMessageForChannel(
    WS_CHANNEL* channel,
    const WS_MESSAGE_PROPERTY* properties,   // optional
    DWORD propertyCount,
    WS_MESSAGE** message,
    WS_ERROR* error   // optional
);

パラメーター

名前型方向説明
channelWS_CHANNEL*inメッセージの設定取得元となるWS_CHANNELオブジェクト。
propertiesWS_MESSAGE_PROPERTY*inoptionalメッセージの初期プロパティ配列。不要ならNULL可。
propertyCountDWORDinproperties配列の要素数を指定する。
messageWS_MESSAGE**out生成されたWS_MESSAGEオブジェクトを受け取る出力ポインタ。
errorWS_ERROR*inoptional詳細なエラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsCreateMessageForChannel(
    WS_CHANNEL* channel,
    const WS_MESSAGE_PROPERTY* properties,   // optional
    DWORD propertyCount,
    WS_MESSAGE** message,
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsCreateMessageForChannel(
    ref IntPtr channel,   // WS_CHANNEL*
    IntPtr properties,   // WS_MESSAGE_PROPERTY* optional
    uint propertyCount,   // DWORD
    IntPtr message,   // WS_MESSAGE** out
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsCreateMessageForChannel(
    ByRef channel As IntPtr,   ' WS_CHANNEL*
    properties As IntPtr,   ' WS_MESSAGE_PROPERTY* optional
    propertyCount As UInteger,   ' DWORD
    message As IntPtr,   ' WS_MESSAGE** out
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' channel : WS_CHANNEL*
' properties : WS_MESSAGE_PROPERTY* optional
' propertyCount : DWORD
' message : WS_MESSAGE** out
' error : WS_ERROR* optional
Declare PtrSafe Function WsCreateMessageForChannel Lib "webservices" ( _
    ByRef channel As LongPtr, _
    ByVal properties As LongPtr, _
    ByVal propertyCount As Long, _
    ByVal message 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

WsCreateMessageForChannel = ctypes.windll.webservices.WsCreateMessageForChannel
WsCreateMessageForChannel.restype = ctypes.c_int
WsCreateMessageForChannel.argtypes = [
    ctypes.c_void_p,  # channel : WS_CHANNEL*
    ctypes.c_void_p,  # properties : WS_MESSAGE_PROPERTY* optional
    wintypes.DWORD,  # propertyCount : DWORD
    ctypes.c_void_p,  # message : WS_MESSAGE** out
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('webservices.dll')
WsCreateMessageForChannel = Fiddle::Function.new(
  lib['WsCreateMessageForChannel'],
  [
    Fiddle::TYPE_VOIDP,  # channel : WS_CHANNEL*
    Fiddle::TYPE_VOIDP,  # properties : WS_MESSAGE_PROPERTY* optional
    -Fiddle::TYPE_INT,  # propertyCount : DWORD
    Fiddle::TYPE_VOIDP,  # message : WS_MESSAGE** out
    Fiddle::TYPE_VOIDP,  # error : WS_ERROR* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "webservices")]
extern "system" {
    fn WsCreateMessageForChannel(
        channel: *mut isize,  // WS_CHANNEL*
        properties: *const WS_MESSAGE_PROPERTY,  // WS_MESSAGE_PROPERTY* optional
        propertyCount: u32,  // DWORD
        message: *mut *mut isize,  // WS_MESSAGE** out
        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 WsCreateMessageForChannel(ref IntPtr channel, IntPtr properties, uint propertyCount, IntPtr message, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsCreateMessageForChannel' -Namespace Win32 -PassThru
# $api::WsCreateMessageForChannel(channel, properties, propertyCount, message, error)
#uselib "webservices.dll"
#func global WsCreateMessageForChannel "WsCreateMessageForChannel" sptr, sptr, sptr, sptr, sptr
; WsCreateMessageForChannel varptr(channel), varptr(properties), propertyCount, varptr(message), varptr(error)   ; 戻り値は stat
; channel : WS_CHANNEL* -> "sptr"
; properties : WS_MESSAGE_PROPERTY* optional -> "sptr"
; propertyCount : DWORD -> "sptr"
; message : WS_MESSAGE** out -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "webservices.dll"
#cfunc global WsCreateMessageForChannel "WsCreateMessageForChannel" var, var, int, var, var
; res = WsCreateMessageForChannel(channel, properties, propertyCount, message, error)
; channel : WS_CHANNEL* -> "var"
; properties : WS_MESSAGE_PROPERTY* optional -> "var"
; propertyCount : DWORD -> "int"
; message : WS_MESSAGE** out -> "var"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT WsCreateMessageForChannel(WS_CHANNEL* channel, WS_MESSAGE_PROPERTY* properties, DWORD propertyCount, WS_MESSAGE** message, WS_ERROR* error)
#uselib "webservices.dll"
#cfunc global WsCreateMessageForChannel "WsCreateMessageForChannel" var, var, int, var, var
; res = WsCreateMessageForChannel(channel, properties, propertyCount, message, error)
; channel : WS_CHANNEL* -> "var"
; properties : WS_MESSAGE_PROPERTY* optional -> "var"
; propertyCount : DWORD -> "int"
; message : WS_MESSAGE** out -> "var"
; error : WS_ERROR* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsCreateMessageForChannel = webservices.NewProc("WsCreateMessageForChannel")
)

// channel (WS_CHANNEL*), properties (WS_MESSAGE_PROPERTY* optional), propertyCount (DWORD), message (WS_MESSAGE** out), error (WS_ERROR* optional)
r1, _, err := procWsCreateMessageForChannel.Call(
	uintptr(channel),
	uintptr(properties),
	uintptr(propertyCount),
	uintptr(message),
	uintptr(error),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WsCreateMessageForChannel(
  channel: Pointer;   // WS_CHANNEL*
  properties: Pointer;   // WS_MESSAGE_PROPERTY* optional
  propertyCount: DWORD;   // DWORD
  message: Pointer;   // WS_MESSAGE** out
  error: Pointer   // WS_ERROR* optional
): Integer; stdcall;
  external 'webservices.dll' name 'WsCreateMessageForChannel';
result := DllCall("webservices\WsCreateMessageForChannel"
    , "Ptr", channel   ; WS_CHANNEL*
    , "Ptr", properties   ; WS_MESSAGE_PROPERTY* optional
    , "UInt", propertyCount   ; DWORD
    , "Ptr", message   ; WS_MESSAGE** out
    , "Ptr", error   ; WS_ERROR* optional
    , "Int")   ; return: HRESULT
●WsCreateMessageForChannel(channel, properties, propertyCount, message, error) = DLL("webservices.dll", "int WsCreateMessageForChannel(void*, void*, dword, void*, void*)")
# 呼び出し: WsCreateMessageForChannel(channel, properties, propertyCount, message, error)
# channel : WS_CHANNEL* -> "void*"
# properties : WS_MESSAGE_PROPERTY* optional -> "void*"
# propertyCount : DWORD -> "dword"
# message : WS_MESSAGE** out -> "void*"
# error : WS_ERROR* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "webservices" fn WsCreateMessageForChannel(
    channel: [*c]isize, // WS_CHANNEL*
    properties: [*c]WS_MESSAGE_PROPERTY, // WS_MESSAGE_PROPERTY* optional
    propertyCount: u32, // DWORD
    message: [*c][*c]isize, // WS_MESSAGE** out
    error: [*c]isize // WS_ERROR* optional
) callconv(std.os.windows.WINAPI) i32;
proc WsCreateMessageForChannel(
    channel: ptr int,  # WS_CHANNEL*
    properties: ptr WS_MESSAGE_PROPERTY,  # WS_MESSAGE_PROPERTY* optional
    propertyCount: uint32,  # DWORD
    message: ptr int,  # WS_MESSAGE** out
    error: ptr int  # WS_ERROR* optional
): int32 {.importc: "WsCreateMessageForChannel", stdcall, dynlib: "webservices.dll".}
pragma(lib, "webservices");
extern(Windows)
int WsCreateMessageForChannel(
    ptrdiff_t* channel,   // WS_CHANNEL*
    WS_MESSAGE_PROPERTY* properties,   // WS_MESSAGE_PROPERTY* optional
    uint propertyCount,   // DWORD
    ptrdiff_t** message,   // WS_MESSAGE** out
    ptrdiff_t* error   // WS_ERROR* optional
);
ccall((:WsCreateMessageForChannel, "webservices.dll"), stdcall, Int32,
      (Ptr{Int}, Ptr{WS_MESSAGE_PROPERTY}, UInt32, Ptr{Int}, Ptr{Int}),
      channel, properties, propertyCount, message, error)
# channel : WS_CHANNEL* -> Ptr{Int}
# properties : WS_MESSAGE_PROPERTY* optional -> Ptr{WS_MESSAGE_PROPERTY}
# propertyCount : DWORD -> UInt32
# message : WS_MESSAGE** out -> Ptr{Int}
# error : WS_ERROR* optional -> Ptr{Int}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WsCreateMessageForChannel(
    intptr_t* channel,
    void* properties,
    uint32_t propertyCount,
    intptr_t** message,
    intptr_t* error);
]]
local webservices = ffi.load("webservices")
-- webservices.WsCreateMessageForChannel(channel, properties, propertyCount, message, error)
-- channel : WS_CHANNEL*
-- properties : WS_MESSAGE_PROPERTY* optional
-- propertyCount : DWORD
-- message : WS_MESSAGE** out
-- error : WS_ERROR* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('webservices.dll');
const WsCreateMessageForChannel = lib.func('__stdcall', 'WsCreateMessageForChannel', 'int32_t', ['intptr_t *', 'void *', 'uint32_t', 'intptr_t *', 'intptr_t *']);
// WsCreateMessageForChannel(channel, properties, propertyCount, message, error)
// channel : WS_CHANNEL* -> 'intptr_t *'
// properties : WS_MESSAGE_PROPERTY* optional -> 'void *'
// propertyCount : DWORD -> 'uint32_t'
// message : WS_MESSAGE** out -> 'intptr_t *'
// error : WS_ERROR* optional -> 'intptr_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("webservices.dll", {
  WsCreateMessageForChannel: { parameters: ["pointer", "pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WsCreateMessageForChannel(channel, properties, propertyCount, message, error)
// channel : WS_CHANNEL* -> "pointer"
// properties : WS_MESSAGE_PROPERTY* optional -> "pointer"
// propertyCount : DWORD -> "u32"
// message : WS_MESSAGE** out -> "pointer"
// error : WS_ERROR* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WsCreateMessageForChannel(
    intptr_t* channel,
    void* properties,
    uint32_t propertyCount,
    intptr_t** message,
    intptr_t* error);
C, "webservices.dll");
// $ffi->WsCreateMessageForChannel(channel, properties, propertyCount, message, error);
// channel : WS_CHANNEL*
// properties : WS_MESSAGE_PROPERTY* optional
// propertyCount : DWORD
// message : WS_MESSAGE** out
// error : WS_ERROR* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Webservices extends StdCallLibrary {
    Webservices INSTANCE = Native.load("webservices", Webservices.class);
    int WsCreateMessageForChannel(
        LongByReference channel,   // WS_CHANNEL*
        Pointer properties,   // WS_MESSAGE_PROPERTY* optional
        int propertyCount,   // DWORD
        Pointer message,   // WS_MESSAGE** out
        LongByReference error   // WS_ERROR* optional
    );
}
@[Link("webservices")]
lib Libwebservices
  fun WsCreateMessageForChannel = WsCreateMessageForChannel(
    channel : LibC::SSizeT*,   # WS_CHANNEL*
    properties : WS_MESSAGE_PROPERTY*,   # WS_MESSAGE_PROPERTY* optional
    propertyCount : UInt32,   # DWORD
    message : LibC::SSizeT**,   # WS_MESSAGE** out
    error : LibC::SSizeT*   # WS_ERROR* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WsCreateMessageForChannelNative = Int32 Function(Pointer<IntPtr>, Pointer<Void>, Uint32, Pointer<IntPtr>, Pointer<IntPtr>);
typedef WsCreateMessageForChannelDart = int Function(Pointer<IntPtr>, Pointer<Void>, int, Pointer<IntPtr>, Pointer<IntPtr>);
final WsCreateMessageForChannel = DynamicLibrary.open('webservices.dll')
    .lookupFunction<WsCreateMessageForChannelNative, WsCreateMessageForChannelDart>('WsCreateMessageForChannel');
// channel : WS_CHANNEL* -> Pointer<IntPtr>
// properties : WS_MESSAGE_PROPERTY* optional -> Pointer<Void>
// propertyCount : DWORD -> Uint32
// message : WS_MESSAGE** out -> Pointer<IntPtr>
// error : WS_ERROR* optional -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WsCreateMessageForChannel(
  channel: Pointer;   // WS_CHANNEL*
  properties: Pointer;   // WS_MESSAGE_PROPERTY* optional
  propertyCount: DWORD;   // DWORD
  message: Pointer;   // WS_MESSAGE** out
  error: Pointer   // WS_ERROR* optional
): Integer; stdcall;
  external 'webservices.dll' name 'WsCreateMessageForChannel';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WsCreateMessageForChannel"
  c_WsCreateMessageForChannel :: Ptr CIntPtr -> Ptr () -> Word32 -> Ptr CIntPtr -> Ptr CIntPtr -> IO Int32
-- channel : WS_CHANNEL* -> Ptr CIntPtr
-- properties : WS_MESSAGE_PROPERTY* optional -> Ptr ()
-- propertyCount : DWORD -> Word32
-- message : WS_MESSAGE** out -> Ptr CIntPtr
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wscreatemessageforchannel =
  foreign "WsCreateMessageForChannel"
    ((ptr intptr_t) @-> (ptr void) @-> uint32_t @-> (ptr intptr_t) @-> (ptr intptr_t) @-> returning int32_t)
(* channel : WS_CHANNEL* -> (ptr intptr_t) *)
(* properties : WS_MESSAGE_PROPERTY* optional -> (ptr void) *)
(* propertyCount : DWORD -> uint32_t *)
(* message : WS_MESSAGE** out -> (ptr intptr_t) *)
(* error : WS_ERROR* optional -> (ptr intptr_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library webservices (t "webservices.dll"))
(cffi:use-foreign-library webservices)

(cffi:defcfun ("WsCreateMessageForChannel" ws-create-message-for-channel :convention :stdcall) :int32
  (channel :pointer)   ; WS_CHANNEL*
  (properties :pointer)   ; WS_MESSAGE_PROPERTY* optional
  (property-count :uint32)   ; DWORD
  (message :pointer)   ; WS_MESSAGE** out
  (error :pointer))   ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsCreateMessageForChannel = Win32::API::More->new('webservices',
    'int WsCreateMessageForChannel(LPVOID channel, LPVOID properties, DWORD propertyCount, LPVOID message, LPVOID error)');
# my $ret = $WsCreateMessageForChannel->Call($channel, $properties, $propertyCount, $message, $error);
# channel : WS_CHANNEL* -> LPVOID
# properties : WS_MESSAGE_PROPERTY* optional -> LPVOID
# propertyCount : DWORD -> DWORD
# message : WS_MESSAGE** out -> LPVOID
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型