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

WsWriteEnvelopeStart

関数
メッセージのエンベロープ開始部を書き込む。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsWriteEnvelopeStart(
    WS_MESSAGE* message,
    WS_XML_WRITER* writer,
    WS_MESSAGE_DONE_CALLBACK doneCallback,   // optional
    void* doneCallbackState,   // optional
    WS_ERROR* error   // optional
);

パラメーター

名前方向説明
messageWS_MESSAGE*inエンベロープ書き込みを開始する対象のWS_MESSAGEオブジェクト。
writerWS_XML_WRITER*in出力先のWS_XML_WRITER。
doneCallbackWS_MESSAGE_DONE_CALLBACKinoptional書き込み完了時に呼ばれるWS_MESSAGE_DONE_CALLBACK。不要ならNULL可。
doneCallbackStatevoid*inoptionaldoneCallbackに渡すユーザー状態ポインタ。NULL可。
errorWS_ERROR*inoptional詳細なエラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsWriteEnvelopeStart(
    WS_MESSAGE* message,
    WS_XML_WRITER* writer,
    WS_MESSAGE_DONE_CALLBACK doneCallback,   // optional
    void* doneCallbackState,   // optional
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsWriteEnvelopeStart(
    ref IntPtr message,   // WS_MESSAGE*
    ref IntPtr writer,   // WS_XML_WRITER*
    IntPtr doneCallback,   // WS_MESSAGE_DONE_CALLBACK optional
    IntPtr doneCallbackState,   // void* optional
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsWriteEnvelopeStart(
    ByRef message As IntPtr,   ' WS_MESSAGE*
    ByRef writer As IntPtr,   ' WS_XML_WRITER*
    doneCallback As IntPtr,   ' WS_MESSAGE_DONE_CALLBACK optional
    doneCallbackState As IntPtr,   ' void* optional
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' message : WS_MESSAGE*
' writer : WS_XML_WRITER*
' doneCallback : WS_MESSAGE_DONE_CALLBACK optional
' doneCallbackState : void* optional
' error : WS_ERROR* optional
Declare PtrSafe Function WsWriteEnvelopeStart Lib "webservices" ( _
    ByRef message As LongPtr, _
    ByRef writer As LongPtr, _
    ByVal doneCallback As LongPtr, _
    ByVal doneCallbackState 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

WsWriteEnvelopeStart = ctypes.windll.webservices.WsWriteEnvelopeStart
WsWriteEnvelopeStart.restype = ctypes.c_int
WsWriteEnvelopeStart.argtypes = [
    ctypes.c_void_p,  # message : WS_MESSAGE*
    ctypes.c_void_p,  # writer : WS_XML_WRITER*
    ctypes.c_void_p,  # doneCallback : WS_MESSAGE_DONE_CALLBACK optional
    ctypes.POINTER(None),  # doneCallbackState : void* optional
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsWriteEnvelopeStart = webservices.NewProc("WsWriteEnvelopeStart")
)

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

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

foreign import stdcall safe "WsWriteEnvelopeStart"
  c_WsWriteEnvelopeStart :: Ptr CIntPtr -> Ptr CIntPtr -> Ptr () -> Ptr () -> Ptr CIntPtr -> IO Int32
-- message : WS_MESSAGE* -> Ptr CIntPtr
-- writer : WS_XML_WRITER* -> Ptr CIntPtr
-- doneCallback : WS_MESSAGE_DONE_CALLBACK optional -> Ptr ()
-- doneCallbackState : void* optional -> Ptr ()
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wswriteenvelopestart =
  foreign "WsWriteEnvelopeStart"
    ((ptr intptr_t) @-> (ptr intptr_t) @-> (ptr void) @-> (ptr void) @-> (ptr intptr_t) @-> returning int32_t)
(* message : WS_MESSAGE* -> (ptr intptr_t) *)
(* writer : WS_XML_WRITER* -> (ptr intptr_t) *)
(* doneCallback : WS_MESSAGE_DONE_CALLBACK optional -> (ptr void) *)
(* doneCallbackState : void* optional -> (ptr void) *)
(* 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 ("WsWriteEnvelopeStart" ws-write-envelope-start :convention :stdcall) :int32
  (message :pointer)   ; WS_MESSAGE*
  (writer :pointer)   ; WS_XML_WRITER*
  (done-callback :pointer)   ; WS_MESSAGE_DONE_CALLBACK optional
  (done-callback-state :pointer)   ; void* optional
  (error :pointer))   ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsWriteEnvelopeStart = Win32::API::More->new('webservices',
    'int WsWriteEnvelopeStart(LPVOID message, LPVOID writer, LPVOID doneCallback, LPVOID doneCallbackState, LPVOID error)');
# my $ret = $WsWriteEnvelopeStart->Call($message, $writer, $doneCallback, $doneCallbackState, $error);
# message : WS_MESSAGE* -> LPVOID
# writer : WS_XML_WRITER* -> LPVOID
# doneCallback : WS_MESSAGE_DONE_CALLBACK optional -> LPVOID
# doneCallbackState : void* optional -> LPVOID
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型