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

WsSetMessageProperty

関数
メッセージの指定したプロパティ値を設定する。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT WsSetMessageProperty(
    WS_MESSAGE* message,
    WS_MESSAGE_PROPERTY_ID id,
    const void* value,
    DWORD valueSize,
    WS_ERROR* error   // optional
);

パラメーター

名前型方向説明
messageWS_MESSAGE*in対象のWS_MESSAGEオブジェクト。
idWS_MESSAGE_PROPERTY_IDin設定するプロパティを識別するWS_MESSAGE_PROPERTY_ID列挙値。
valuevoid*in設定する値を格納したバッファへのポインタ。
valueSizeDWORDinvalueバッファのバイトサイズを指定する。
errorWS_ERROR*inoptional詳細なエラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsSetMessageProperty(
    WS_MESSAGE* message,
    WS_MESSAGE_PROPERTY_ID id,
    const void* value,
    DWORD valueSize,
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsSetMessageProperty(
    ref IntPtr message,   // WS_MESSAGE*
    int id,   // WS_MESSAGE_PROPERTY_ID
    IntPtr value,   // void*
    uint valueSize,   // DWORD
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsSetMessageProperty(
    ByRef message As IntPtr,   ' WS_MESSAGE*
    id As Integer,   ' WS_MESSAGE_PROPERTY_ID
    value As IntPtr,   ' void*
    valueSize As UInteger,   ' DWORD
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' message : WS_MESSAGE*
' id : WS_MESSAGE_PROPERTY_ID
' value : void*
' valueSize : DWORD
' error : WS_ERROR* optional
Declare PtrSafe Function WsSetMessageProperty Lib "webservices" ( _
    ByRef message As LongPtr, _
    ByVal id As Long, _
    ByVal value As LongPtr, _
    ByVal valueSize As Long, _
    ByVal error As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WsSetMessageProperty = ctypes.windll.webservices.WsSetMessageProperty
WsSetMessageProperty.restype = ctypes.c_int
WsSetMessageProperty.argtypes = [
    ctypes.c_void_p,  # message : WS_MESSAGE*
    ctypes.c_int,  # id : WS_MESSAGE_PROPERTY_ID
    ctypes.POINTER(None),  # value : void*
    wintypes.DWORD,  # valueSize : DWORD
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsSetMessageProperty = webservices.NewProc("WsSetMessageProperty")
)

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

extern "webservices" fn WsSetMessageProperty(
    message: [*c]isize, // WS_MESSAGE*
    id: i32, // WS_MESSAGE_PROPERTY_ID
    value: ?*anyopaque, // void*
    valueSize: u32, // DWORD
    error: [*c]isize // WS_ERROR* optional
) callconv(std.os.windows.WINAPI) i32;
proc WsSetMessageProperty(
    message: ptr int,  # WS_MESSAGE*
    id: int32,  # WS_MESSAGE_PROPERTY_ID
    value: pointer,  # void*
    valueSize: uint32,  # DWORD
    error: ptr int  # WS_ERROR* optional
): int32 {.importc: "WsSetMessageProperty", stdcall, dynlib: "webservices.dll".}
pragma(lib, "webservices");
extern(Windows)
int WsSetMessageProperty(
    ptrdiff_t* message,   // WS_MESSAGE*
    int id,   // WS_MESSAGE_PROPERTY_ID
    void* value,   // void*
    uint valueSize,   // DWORD
    ptrdiff_t* error   // WS_ERROR* optional
);
ccall((:WsSetMessageProperty, "webservices.dll"), stdcall, Int32,
      (Ptr{Int}, Int32, Ptr{Cvoid}, UInt32, Ptr{Int}),
      message, id, value, valueSize, error)
# message : WS_MESSAGE* -> Ptr{Int}
# id : WS_MESSAGE_PROPERTY_ID -> Int32
# value : void* -> Ptr{Cvoid}
# valueSize : DWORD -> UInt32
# error : WS_ERROR* optional -> Ptr{Int}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WsSetMessageProperty(
    intptr_t* message,
    int32_t id,
    void* value,
    uint32_t valueSize,
    intptr_t* error);
]]
local webservices = ffi.load("webservices")
-- webservices.WsSetMessageProperty(message, id, value, valueSize, error)
-- message : WS_MESSAGE*
-- id : WS_MESSAGE_PROPERTY_ID
-- value : void*
-- valueSize : DWORD
-- error : WS_ERROR* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('webservices.dll');
const WsSetMessageProperty = lib.func('__stdcall', 'WsSetMessageProperty', 'int32_t', ['intptr_t *', 'int32_t', 'void *', 'uint32_t', 'intptr_t *']);
// WsSetMessageProperty(message, id, value, valueSize, error)
// message : WS_MESSAGE* -> 'intptr_t *'
// id : WS_MESSAGE_PROPERTY_ID -> 'int32_t'
// value : void* -> 'void *'
// valueSize : DWORD -> 'uint32_t'
// error : WS_ERROR* optional -> 'intptr_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("webservices.dll", {
  WsSetMessageProperty: { parameters: ["pointer", "i32", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WsSetMessageProperty(message, id, value, valueSize, error)
// message : WS_MESSAGE* -> "pointer"
// id : WS_MESSAGE_PROPERTY_ID -> "i32"
// value : void* -> "pointer"
// valueSize : DWORD -> "u32"
// error : WS_ERROR* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WsSetMessageProperty(
    intptr_t* message,
    int32_t id,
    void* value,
    uint32_t valueSize,
    intptr_t* error);
C, "webservices.dll");
// $ffi->WsSetMessageProperty(message, id, value, valueSize, error);
// message : WS_MESSAGE*
// id : WS_MESSAGE_PROPERTY_ID
// value : void*
// valueSize : DWORD
// 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 WsSetMessageProperty(
        LongByReference message,   // WS_MESSAGE*
        int id,   // WS_MESSAGE_PROPERTY_ID
        Pointer value,   // void*
        int valueSize,   // DWORD
        LongByReference error   // WS_ERROR* optional
    );
}
@[Link("webservices")]
lib Libwebservices
  fun WsSetMessageProperty = WsSetMessageProperty(
    message : LibC::SSizeT*,   # WS_MESSAGE*
    id : Int32,   # WS_MESSAGE_PROPERTY_ID
    value : Void*,   # void*
    valueSize : UInt32,   # DWORD
    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 WsSetMessagePropertyNative = Int32 Function(Pointer<IntPtr>, Int32, Pointer<Void>, Uint32, Pointer<IntPtr>);
typedef WsSetMessagePropertyDart = int Function(Pointer<IntPtr>, int, Pointer<Void>, int, Pointer<IntPtr>);
final WsSetMessageProperty = DynamicLibrary.open('webservices.dll')
    .lookupFunction<WsSetMessagePropertyNative, WsSetMessagePropertyDart>('WsSetMessageProperty');
// message : WS_MESSAGE* -> Pointer<IntPtr>
// id : WS_MESSAGE_PROPERTY_ID -> Int32
// value : void* -> Pointer<Void>
// valueSize : DWORD -> Uint32
// error : WS_ERROR* optional -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WsSetMessageProperty(
  message: Pointer;   // WS_MESSAGE*
  id: Integer;   // WS_MESSAGE_PROPERTY_ID
  value: Pointer;   // void*
  valueSize: DWORD;   // DWORD
  error: Pointer   // WS_ERROR* optional
): Integer; stdcall;
  external 'webservices.dll' name 'WsSetMessageProperty';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WsSetMessageProperty"
  c_WsSetMessageProperty :: Ptr CIntPtr -> Int32 -> Ptr () -> Word32 -> Ptr CIntPtr -> IO Int32
-- message : WS_MESSAGE* -> Ptr CIntPtr
-- id : WS_MESSAGE_PROPERTY_ID -> Int32
-- value : void* -> Ptr ()
-- valueSize : DWORD -> Word32
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wssetmessageproperty =
  foreign "WsSetMessageProperty"
    ((ptr intptr_t) @-> int32_t @-> (ptr void) @-> uint32_t @-> (ptr intptr_t) @-> returning int32_t)
(* message : WS_MESSAGE* -> (ptr intptr_t) *)
(* id : WS_MESSAGE_PROPERTY_ID -> int32_t *)
(* value : void* -> (ptr void) *)
(* valueSize : DWORD -> uint32_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 ("WsSetMessageProperty" ws-set-message-property :convention :stdcall) :int32
  (message :pointer)   ; WS_MESSAGE*
  (id :int32)   ; WS_MESSAGE_PROPERTY_ID
  (value :pointer)   ; void*
  (value-size :uint32)   ; DWORD
  (error :pointer))   ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsSetMessageProperty = Win32::API::More->new('webservices',
    'int WsSetMessageProperty(LPVOID message, int id, LPVOID value, DWORD valueSize, LPVOID error)');
# my $ret = $WsSetMessageProperty->Call($message, $id, $value, $valueSize, $error);
# message : WS_MESSAGE* -> LPVOID
# id : WS_MESSAGE_PROPERTY_ID -> int
# value : void* -> LPVOID
# valueSize : DWORD -> DWORD
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型