ホーム › 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 |
| headerDescription | WS_ELEMENT_DESCRIPTION* | in |
| writeOption | WS_WRITE_OPTION | in |
| value | void* | in |
| valueSize | DWORD | in |
| headerAttributes | DWORD | in |
| error | WS_ERROR* | inoptional |
戻り値の型: 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 message, varptr(headerDescription), writeOption, value, valueSize, headerAttributes, 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" int, var, int, sptr, int, int, int ; res = WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error) ; message : WS_MESSAGE* -> "int" ; headerDescription : WS_ELEMENT_DESCRIPTION* -> "var" ; writeOption : WS_WRITE_OPTION -> "int" ; value : void* -> "sptr" ; valueSize : DWORD -> "int" ; headerAttributes : DWORD -> "int" ; error : WS_ERROR* optional -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "webservices.dll" #cfunc global WsAddCustomHeader "WsAddCustomHeader" int, sptr, int, sptr, int, int, int ; res = WsAddCustomHeader(message, varptr(headerDescription), writeOption, value, valueSize, headerAttributes, error) ; message : WS_MESSAGE* -> "int" ; headerDescription : WS_ELEMENT_DESCRIPTION* -> "sptr" ; writeOption : WS_WRITE_OPTION -> "int" ; value : void* -> "sptr" ; valueSize : DWORD -> "int" ; headerAttributes : DWORD -> "int" ; error : WS_ERROR* optional -> "int" ; ※出力/バッファ引数はポインタ方式(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" int, var, int, intptr, int, int, int ; res = WsAddCustomHeader(message, headerDescription, writeOption, value, valueSize, headerAttributes, error) ; message : WS_MESSAGE* -> "int" ; headerDescription : WS_ELEMENT_DESCRIPTION* -> "var" ; writeOption : WS_WRITE_OPTION -> "int" ; value : void* -> "intptr" ; valueSize : DWORD -> "int" ; headerAttributes : DWORD -> "int" ; error : WS_ERROR* optional -> "int" ; ※出力/バッファ引数は 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" int, intptr, int, intptr, int, int, int ; res = WsAddCustomHeader(message, varptr(headerDescription), writeOption, value, valueSize, headerAttributes, error) ; message : WS_MESSAGE* -> "int" ; headerDescription : WS_ELEMENT_DESCRIPTION* -> "intptr" ; writeOption : WS_WRITE_OPTION -> "int" ; value : void* -> "intptr" ; valueSize : DWORD -> "int" ; headerAttributes : DWORD -> "int" ; error : WS_ERROR* optional -> "int" ; ※出力/バッファ引数はポインタ方式(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)。