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

WsGetHeader

関数
メッセージから標準ヘッダーを取得する。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT WsGetHeader(
    WS_MESSAGE* message,
    WS_HEADER_TYPE headerType,
    WS_TYPE valueType,
    WS_READ_OPTION readOption,
    WS_HEAP* heap,   // optional
    void* value,
    DWORD valueSize,
    WS_ERROR* error   // optional
);

パラメーター

名前型方向説明
messageWS_MESSAGE*inヘッダーを取得する対象のWS_MESSAGEオブジェクト。
headerTypeWS_HEADER_TYPEin取得する標準ヘッダーの種別を示すWS_HEADER_TYPE列挙値。
valueTypeWS_TYPEinデシリアライズ先の型を示すWS_TYPE列挙値。
readOptionWS_READ_OPTIONin値の必須有無や割り当て方法を示すWS_READ_OPTION。
heapWS_HEAP*inoptional可変長データの確保に使うWS_HEAP。
valuevoid*out読み取った値を受け取る出力バッファへのポインタ。
valueSizeDWORDinvalueバッファのバイトサイズを指定する。
errorWS_ERROR*inoptional詳細なエラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsGetHeader(
    WS_MESSAGE* message,
    WS_HEADER_TYPE headerType,
    WS_TYPE valueType,
    WS_READ_OPTION readOption,
    WS_HEAP* heap,   // optional
    void* value,
    DWORD valueSize,
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsGetHeader(
    ref IntPtr message,   // WS_MESSAGE*
    int headerType,   // WS_HEADER_TYPE
    int valueType,   // WS_TYPE
    int readOption,   // WS_READ_OPTION
    IntPtr heap,   // WS_HEAP* optional
    IntPtr value,   // void* out
    uint valueSize,   // DWORD
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsGetHeader(
    ByRef message As IntPtr,   ' WS_MESSAGE*
    headerType As Integer,   ' WS_HEADER_TYPE
    valueType As Integer,   ' WS_TYPE
    readOption As Integer,   ' WS_READ_OPTION
    heap As IntPtr,   ' WS_HEAP* optional
    value As IntPtr,   ' void* out
    valueSize As UInteger,   ' DWORD
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' message : WS_MESSAGE*
' headerType : WS_HEADER_TYPE
' valueType : WS_TYPE
' readOption : WS_READ_OPTION
' heap : WS_HEAP* optional
' value : void* out
' valueSize : DWORD
' error : WS_ERROR* optional
Declare PtrSafe Function WsGetHeader Lib "webservices" ( _
    ByRef message As LongPtr, _
    ByVal headerType As Long, _
    ByVal valueType As Long, _
    ByVal readOption As Long, _
    ByVal heap As LongPtr, _
    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

WsGetHeader = ctypes.windll.webservices.WsGetHeader
WsGetHeader.restype = ctypes.c_int
WsGetHeader.argtypes = [
    ctypes.c_void_p,  # message : WS_MESSAGE*
    ctypes.c_int,  # headerType : WS_HEADER_TYPE
    ctypes.c_int,  # valueType : WS_TYPE
    ctypes.c_int,  # readOption : WS_READ_OPTION
    ctypes.c_void_p,  # heap : WS_HEAP* optional
    ctypes.POINTER(None),  # value : void* out
    wintypes.DWORD,  # valueSize : DWORD
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsGetHeader = webservices.NewProc("WsGetHeader")
)

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

foreign import stdcall safe "WsGetHeader"
  c_WsGetHeader :: Ptr CIntPtr -> Int32 -> Int32 -> Int32 -> Ptr CIntPtr -> Ptr () -> Word32 -> Ptr CIntPtr -> IO Int32
-- message : WS_MESSAGE* -> Ptr CIntPtr
-- headerType : WS_HEADER_TYPE -> Int32
-- valueType : WS_TYPE -> Int32
-- readOption : WS_READ_OPTION -> Int32
-- heap : WS_HEAP* optional -> Ptr CIntPtr
-- value : void* out -> Ptr ()
-- valueSize : DWORD -> Word32
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsgetheader =
  foreign "WsGetHeader"
    ((ptr intptr_t) @-> int32_t @-> int32_t @-> int32_t @-> (ptr intptr_t) @-> (ptr void) @-> uint32_t @-> (ptr intptr_t) @-> returning int32_t)
(* message : WS_MESSAGE* -> (ptr intptr_t) *)
(* headerType : WS_HEADER_TYPE -> int32_t *)
(* valueType : WS_TYPE -> int32_t *)
(* readOption : WS_READ_OPTION -> int32_t *)
(* heap : WS_HEAP* optional -> (ptr intptr_t) *)
(* value : void* out -> (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 ("WsGetHeader" ws-get-header :convention :stdcall) :int32
  (message :pointer)   ; WS_MESSAGE*
  (header-type :int32)   ; WS_HEADER_TYPE
  (value-type :int32)   ; WS_TYPE
  (read-option :int32)   ; WS_READ_OPTION
  (heap :pointer)   ; WS_HEAP* optional
  (value :pointer)   ; void* out
  (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 $WsGetHeader = Win32::API::More->new('webservices',
    'int WsGetHeader(LPVOID message, int headerType, int valueType, int readOption, LPVOID heap, LPVOID value, DWORD valueSize, LPVOID error)');
# my $ret = $WsGetHeader->Call($message, $headerType, $valueType, $readOption, $heap, $value, $valueSize, $error);
# message : WS_MESSAGE* -> LPVOID
# headerType : WS_HEADER_TYPE -> int
# valueType : WS_TYPE -> int
# readOption : WS_READ_OPTION -> int
# heap : WS_HEAP* optional -> LPVOID
# value : void* out -> LPVOID
# valueSize : DWORD -> DWORD
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型