ホーム › Networking.WindowsWebServices › WsAddCustomHeader
WsAddCustomHeader
関数メッセージにカスタムヘッダーを追加する。
シグネチャ
// webservices.dll
#include <windows.h>
HRESULT WsAddCustomHeader(
WS_MESSAGE* message,
const WS_ELEMENT_DESCRIPTION* headerDescription,
WS_WRITE_OPTION writeOption,
const void* value,
DWORD valueSize,
DWORD headerAttributes,
WS_ERROR* error // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| message | WS_MESSAGE* | in | ヘッダーを追加する対象のWS_MESSAGEオブジェクト。 |
| headerDescription | WS_ELEMENT_DESCRIPTION* | in | 追加するカスタムヘッダーの要素定義を示すWS_ELEMENT_DESCRIPTION。 |
| writeOption | WS_WRITE_OPTION | in | 値の必須有無やNULL扱いを示すWS_WRITE_OPTION。 |
| value | void* | in | 追加する値を格納したバッファへのポインタ。 |
| valueSize | DWORD | in | valueバッファのバイトサイズを指定する。 |
| headerAttributes | DWORD | in | 付与するヘッダー属性フラグ。mustUnderstandやrelay等を指定する。 |
| error | WS_ERROR* | inoptional | 詳細なエラー情報を格納するWS_ERRORオブジェクト。NULL可。 |
戻り値の型: HRESULT
各言語での呼び出し定義
// webservices.dll
#include <windows.h>
HRESULT WsAddCustomHeader(
WS_MESSAGE* message,
const WS_ELEMENT_DESCRIPTION* headerDescription,
WS_WRITE_OPTION writeOption,
const void* value,
DWORD valueSize,
DWORD headerAttributes,
WS_ERROR* error // optional
);[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsAddCustomHeader(
ref IntPtr message, // WS_MESSAGE*
IntPtr headerDescription, // WS_ELEMENT_DESCRIPTION*
int writeOption, // WS_WRITE_OPTION
IntPtr value, // void*
uint valueSize, // DWORD
uint headerAttributes, // DWORD
IntPtr error // WS_ERROR* optional
);<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsAddCustomHeader(
ByRef message As IntPtr, ' WS_MESSAGE*
headerDescription As IntPtr, ' WS_ELEMENT_DESCRIPTION*
writeOption As Integer, ' WS_WRITE_OPTION
value As IntPtr, ' void*
valueSize As UInteger, ' DWORD
headerAttributes As UInteger, ' DWORD
[error] As IntPtr ' WS_ERROR* optional
) As Integer
End Function' message : WS_MESSAGE*
' headerDescription : WS_ELEMENT_DESCRIPTION*
' writeOption : WS_WRITE_OPTION
' value : void*
' valueSize : DWORD
' headerAttributes : DWORD
' error : WS_ERROR* optional
Declare PtrSafe Function WsAddCustomHeader Lib "webservices" ( _
ByRef message As LongPtr, _
ByVal headerDescription As LongPtr, _
ByVal writeOption As Long, _
ByVal value As LongPtr, _
ByVal valueSize As Long, _
ByVal headerAttributes 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
WsAddCustomHeader = ctypes.windll.webservices.WsAddCustomHeader
WsAddCustomHeader.restype = ctypes.c_int
WsAddCustomHeader.argtypes = [
ctypes.c_void_p, # message : WS_MESSAGE*
ctypes.c_void_p, # headerDescription : WS_ELEMENT_DESCRIPTION*
ctypes.c_int, # writeOption : WS_WRITE_OPTION
ctypes.POINTER(None), # value : void*
wintypes.DWORD, # valueSize : DWORD
wintypes.DWORD, # headerAttributes : DWORD
ctypes.c_void_p, # error : WS_ERROR* optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('webservices.dll')
WsAddCustomHeader = Fiddle::Function.new(
lib['WsAddCustomHeader'],
[
Fiddle::TYPE_VOIDP, # message : WS_MESSAGE*
Fiddle::TYPE_VOIDP, # headerDescription : WS_ELEMENT_DESCRIPTION*
Fiddle::TYPE_INT, # writeOption : WS_WRITE_OPTION
Fiddle::TYPE_VOIDP, # value : void*
-Fiddle::TYPE_INT, # valueSize : DWORD
-Fiddle::TYPE_INT, # headerAttributes : DWORD
Fiddle::TYPE_VOIDP, # error : WS_ERROR* optional
],
Fiddle::TYPE_INT)#[link(name = "webservices")]
extern "system" {
fn WsAddCustomHeader(
message: *mut isize, // WS_MESSAGE*
headerDescription: *const WS_ELEMENT_DESCRIPTION, // WS_ELEMENT_DESCRIPTION*
writeOption: i32, // WS_WRITE_OPTION
value: *const (), // void*
valueSize: u32, // DWORD
headerAttributes: 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 WsAddCustomHeader(ref IntPtr message, IntPtr headerDescription, int writeOption, IntPtr value, uint valueSize, uint headerAttributes, IntPtr error);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsAddCustomHeader' -Namespace Win32 -PassThru
# $api::WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error)#uselib "webservices.dll"
#func global WsAddCustomHeader "WsAddCustomHeader" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WsAddCustomHeader varptr(message), varptr(headerDescription), writeOption, value, valueSize, headerAttributes, varptr(error) ; 戻り値は stat
; message : WS_MESSAGE* -> "sptr"
; headerDescription : WS_ELEMENT_DESCRIPTION* -> "sptr"
; writeOption : WS_WRITE_OPTION -> "sptr"
; value : void* -> "sptr"
; valueSize : DWORD -> "sptr"
; headerAttributes : DWORD -> "sptr"
; error : WS_ERROR* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "webservices.dll" #cfunc global WsAddCustomHeader "WsAddCustomHeader" var, var, int, sptr, int, int, var ; res = WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error) ; message : WS_MESSAGE* -> "var" ; headerDescription : WS_ELEMENT_DESCRIPTION* -> "var" ; writeOption : WS_WRITE_OPTION -> "int" ; value : void* -> "sptr" ; valueSize : DWORD -> "int" ; headerAttributes : DWORD -> "int" ; error : WS_ERROR* optional -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "webservices.dll" #cfunc global WsAddCustomHeader "WsAddCustomHeader" sptr, sptr, int, sptr, int, int, sptr ; res = WsAddCustomHeader(varptr(message), varptr(headerDescription), writeOption, value, valueSize, headerAttributes, varptr(error)) ; message : WS_MESSAGE* -> "sptr" ; headerDescription : WS_ELEMENT_DESCRIPTION* -> "sptr" ; writeOption : WS_WRITE_OPTION -> "int" ; value : void* -> "sptr" ; valueSize : DWORD -> "int" ; headerAttributes : DWORD -> "int" ; error : WS_ERROR* optional -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT WsAddCustomHeader(WS_MESSAGE* message, WS_ELEMENT_DESCRIPTION* headerDescription, WS_WRITE_OPTION writeOption, void* value, DWORD valueSize, DWORD headerAttributes, WS_ERROR* error) #uselib "webservices.dll" #cfunc global WsAddCustomHeader "WsAddCustomHeader" var, var, int, intptr, int, int, var ; res = WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error) ; message : WS_MESSAGE* -> "var" ; headerDescription : WS_ELEMENT_DESCRIPTION* -> "var" ; writeOption : WS_WRITE_OPTION -> "int" ; value : void* -> "intptr" ; valueSize : DWORD -> "int" ; headerAttributes : DWORD -> "int" ; error : WS_ERROR* optional -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT WsAddCustomHeader(WS_MESSAGE* message, WS_ELEMENT_DESCRIPTION* headerDescription, WS_WRITE_OPTION writeOption, void* value, DWORD valueSize, DWORD headerAttributes, WS_ERROR* error) #uselib "webservices.dll" #cfunc global WsAddCustomHeader "WsAddCustomHeader" intptr, intptr, int, intptr, int, int, intptr ; res = WsAddCustomHeader(varptr(message), varptr(headerDescription), writeOption, value, valueSize, headerAttributes, varptr(error)) ; message : WS_MESSAGE* -> "intptr" ; headerDescription : WS_ELEMENT_DESCRIPTION* -> "intptr" ; writeOption : WS_WRITE_OPTION -> "int" ; value : void* -> "intptr" ; valueSize : DWORD -> "int" ; headerAttributes : DWORD -> "int" ; error : WS_ERROR* optional -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
webservices = windows.NewLazySystemDLL("webservices.dll")
procWsAddCustomHeader = webservices.NewProc("WsAddCustomHeader")
)
// message (WS_MESSAGE*), headerDescription (WS_ELEMENT_DESCRIPTION*), writeOption (WS_WRITE_OPTION), value (void*), valueSize (DWORD), headerAttributes (DWORD), error (WS_ERROR* optional)
r1, _, err := procWsAddCustomHeader.Call(
uintptr(message),
uintptr(headerDescription),
uintptr(writeOption),
uintptr(value),
uintptr(valueSize),
uintptr(headerAttributes),
uintptr(error),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction WsAddCustomHeader(
message: Pointer; // WS_MESSAGE*
headerDescription: Pointer; // WS_ELEMENT_DESCRIPTION*
writeOption: Integer; // WS_WRITE_OPTION
value: Pointer; // void*
valueSize: DWORD; // DWORD
headerAttributes: DWORD; // DWORD
error: Pointer // WS_ERROR* optional
): Integer; stdcall;
external 'webservices.dll' name 'WsAddCustomHeader';result := DllCall("webservices\WsAddCustomHeader"
, "Ptr", message ; WS_MESSAGE*
, "Ptr", headerDescription ; WS_ELEMENT_DESCRIPTION*
, "Int", writeOption ; WS_WRITE_OPTION
, "Ptr", value ; void*
, "UInt", valueSize ; DWORD
, "UInt", headerAttributes ; DWORD
, "Ptr", error ; WS_ERROR* optional
, "Int") ; return: HRESULT●WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error) = DLL("webservices.dll", "int WsAddCustomHeader(void*, void*, int, void*, dword, dword, void*)")
# 呼び出し: WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error)
# message : WS_MESSAGE* -> "void*"
# headerDescription : WS_ELEMENT_DESCRIPTION* -> "void*"
# writeOption : WS_WRITE_OPTION -> "int"
# value : void* -> "void*"
# valueSize : DWORD -> "dword"
# headerAttributes : DWORD -> "dword"
# error : WS_ERROR* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "webservices" fn WsAddCustomHeader(
message: [*c]isize, // WS_MESSAGE*
headerDescription: [*c]WS_ELEMENT_DESCRIPTION, // WS_ELEMENT_DESCRIPTION*
writeOption: i32, // WS_WRITE_OPTION
value: ?*anyopaque, // void*
valueSize: u32, // DWORD
headerAttributes: u32, // DWORD
error: [*c]isize // WS_ERROR* optional
) callconv(std.os.windows.WINAPI) i32;proc WsAddCustomHeader(
message: ptr int, # WS_MESSAGE*
headerDescription: ptr WS_ELEMENT_DESCRIPTION, # WS_ELEMENT_DESCRIPTION*
writeOption: int32, # WS_WRITE_OPTION
value: pointer, # void*
valueSize: uint32, # DWORD
headerAttributes: uint32, # DWORD
error: ptr int # WS_ERROR* optional
): int32 {.importc: "WsAddCustomHeader", stdcall, dynlib: "webservices.dll".}pragma(lib, "webservices");
extern(Windows)
int WsAddCustomHeader(
ptrdiff_t* message, // WS_MESSAGE*
WS_ELEMENT_DESCRIPTION* headerDescription, // WS_ELEMENT_DESCRIPTION*
int writeOption, // WS_WRITE_OPTION
void* value, // void*
uint valueSize, // DWORD
uint headerAttributes, // DWORD
ptrdiff_t* error // WS_ERROR* optional
);ccall((:WsAddCustomHeader, "webservices.dll"), stdcall, Int32,
(Ptr{Int}, Ptr{WS_ELEMENT_DESCRIPTION}, Int32, Ptr{Cvoid}, UInt32, UInt32, Ptr{Int}),
message, headerDescription, writeOption, value, valueSize, headerAttributes, error)
# message : WS_MESSAGE* -> Ptr{Int}
# headerDescription : WS_ELEMENT_DESCRIPTION* -> Ptr{WS_ELEMENT_DESCRIPTION}
# writeOption : WS_WRITE_OPTION -> Int32
# value : void* -> Ptr{Cvoid}
# valueSize : DWORD -> UInt32
# headerAttributes : DWORD -> UInt32
# error : WS_ERROR* optional -> Ptr{Int}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WsAddCustomHeader(
intptr_t* message,
void* headerDescription,
int32_t writeOption,
void* value,
uint32_t valueSize,
uint32_t headerAttributes,
intptr_t* error);
]]
local webservices = ffi.load("webservices")
-- webservices.WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error)
-- message : WS_MESSAGE*
-- headerDescription : WS_ELEMENT_DESCRIPTION*
-- writeOption : WS_WRITE_OPTION
-- value : void*
-- valueSize : DWORD
-- headerAttributes : DWORD
-- error : WS_ERROR* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('webservices.dll');
const WsAddCustomHeader = lib.func('__stdcall', 'WsAddCustomHeader', 'int32_t', ['intptr_t *', 'void *', 'int32_t', 'void *', 'uint32_t', 'uint32_t', 'intptr_t *']);
// WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error)
// message : WS_MESSAGE* -> 'intptr_t *'
// headerDescription : WS_ELEMENT_DESCRIPTION* -> 'void *'
// writeOption : WS_WRITE_OPTION -> 'int32_t'
// value : void* -> 'void *'
// valueSize : DWORD -> 'uint32_t'
// headerAttributes : DWORD -> 'uint32_t'
// error : WS_ERROR* optional -> 'intptr_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("webservices.dll", {
WsAddCustomHeader: { parameters: ["pointer", "pointer", "i32", "pointer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error)
// message : WS_MESSAGE* -> "pointer"
// headerDescription : WS_ELEMENT_DESCRIPTION* -> "pointer"
// writeOption : WS_WRITE_OPTION -> "i32"
// value : void* -> "pointer"
// valueSize : DWORD -> "u32"
// headerAttributes : DWORD -> "u32"
// error : WS_ERROR* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WsAddCustomHeader(
intptr_t* message,
void* headerDescription,
int32_t writeOption,
void* value,
uint32_t valueSize,
uint32_t headerAttributes,
intptr_t* error);
C, "webservices.dll");
// $ffi->WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error);
// message : WS_MESSAGE*
// headerDescription : WS_ELEMENT_DESCRIPTION*
// writeOption : WS_WRITE_OPTION
// value : void*
// valueSize : DWORD
// headerAttributes : 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 WsAddCustomHeader(
LongByReference message, // WS_MESSAGE*
Pointer headerDescription, // WS_ELEMENT_DESCRIPTION*
int writeOption, // WS_WRITE_OPTION
Pointer value, // void*
int valueSize, // DWORD
int headerAttributes, // DWORD
LongByReference error // WS_ERROR* optional
);
}@[Link("webservices")]
lib Libwebservices
fun WsAddCustomHeader = WsAddCustomHeader(
message : LibC::SSizeT*, # WS_MESSAGE*
headerDescription : WS_ELEMENT_DESCRIPTION*, # WS_ELEMENT_DESCRIPTION*
writeOption : Int32, # WS_WRITE_OPTION
value : Void*, # void*
valueSize : UInt32, # DWORD
headerAttributes : 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 WsAddCustomHeaderNative = Int32 Function(Pointer<IntPtr>, Pointer<Void>, Int32, Pointer<Void>, Uint32, Uint32, Pointer<IntPtr>);
typedef WsAddCustomHeaderDart = int Function(Pointer<IntPtr>, Pointer<Void>, int, Pointer<Void>, int, int, Pointer<IntPtr>);
final WsAddCustomHeader = DynamicLibrary.open('webservices.dll')
.lookupFunction<WsAddCustomHeaderNative, WsAddCustomHeaderDart>('WsAddCustomHeader');
// message : WS_MESSAGE* -> Pointer<IntPtr>
// headerDescription : WS_ELEMENT_DESCRIPTION* -> Pointer<Void>
// writeOption : WS_WRITE_OPTION -> Int32
// value : void* -> Pointer<Void>
// valueSize : DWORD -> Uint32
// headerAttributes : DWORD -> Uint32
// error : WS_ERROR* optional -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WsAddCustomHeader(
message: Pointer; // WS_MESSAGE*
headerDescription: Pointer; // WS_ELEMENT_DESCRIPTION*
writeOption: Integer; // WS_WRITE_OPTION
value: Pointer; // void*
valueSize: DWORD; // DWORD
headerAttributes: DWORD; // DWORD
error: Pointer // WS_ERROR* optional
): Integer; stdcall;
external 'webservices.dll' name 'WsAddCustomHeader';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WsAddCustomHeader"
c_WsAddCustomHeader :: Ptr CIntPtr -> Ptr () -> Int32 -> Ptr () -> Word32 -> Word32 -> Ptr CIntPtr -> IO Int32
-- message : WS_MESSAGE* -> Ptr CIntPtr
-- headerDescription : WS_ELEMENT_DESCRIPTION* -> Ptr ()
-- writeOption : WS_WRITE_OPTION -> Int32
-- value : void* -> Ptr ()
-- valueSize : DWORD -> Word32
-- headerAttributes : DWORD -> Word32
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let wsaddcustomheader =
foreign "WsAddCustomHeader"
((ptr intptr_t) @-> (ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> (ptr intptr_t) @-> returning int32_t)
(* message : WS_MESSAGE* -> (ptr intptr_t) *)
(* headerDescription : WS_ELEMENT_DESCRIPTION* -> (ptr void) *)
(* writeOption : WS_WRITE_OPTION -> int32_t *)
(* value : void* -> (ptr void) *)
(* valueSize : DWORD -> uint32_t *)
(* headerAttributes : 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 ("WsAddCustomHeader" ws-add-custom-header :convention :stdcall) :int32
(message :pointer) ; WS_MESSAGE*
(header-description :pointer) ; WS_ELEMENT_DESCRIPTION*
(write-option :int32) ; WS_WRITE_OPTION
(value :pointer) ; void*
(value-size :uint32) ; DWORD
(header-attributes :uint32) ; DWORD
(error :pointer)) ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WsAddCustomHeader = Win32::API::More->new('webservices',
'int WsAddCustomHeader(LPVOID message, LPVOID headerDescription, int writeOption, LPVOID value, DWORD valueSize, DWORD headerAttributes, LPVOID error)');
# my $ret = $WsAddCustomHeader->Call($message, $headerDescription, $writeOption, $value, $valueSize, $headerAttributes, $error);
# message : WS_MESSAGE* -> LPVOID
# headerDescription : WS_ELEMENT_DESCRIPTION* -> LPVOID
# writeOption : WS_WRITE_OPTION -> int
# value : void* -> LPVOID
# valueSize : DWORD -> DWORD
# headerAttributes : DWORD -> DWORD
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。