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

WsPullBytes

関数
コールバック経由でXMLにバイト列をプル書き込みする。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsPullBytes(
    WS_XML_WRITER* writer,
    WS_PULL_BYTES_CALLBACK callback,
    void* callbackState,   // optional
    WS_ERROR* error   // optional
);

パラメーター

名前方向説明
writerWS_XML_WRITER*in対象のXMLライター。コールバックがライターからバイトを取得する。
callbackWS_PULL_BYTES_CALLBACKinライターが用意したバイトを引き取るプルコールバック。
callbackStatevoid*inoptionalcallbackに渡されるユーザー定義状態。NULL可。
errorWS_ERROR*inoptional失敗時の追加エラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

WsPullBytes = ctypes.windll.webservices.WsPullBytes
WsPullBytes.restype = ctypes.c_int
WsPullBytes.argtypes = [
    ctypes.c_void_p,  # writer : WS_XML_WRITER*
    ctypes.c_void_p,  # callback : WS_PULL_BYTES_CALLBACK
    ctypes.POINTER(None),  # callbackState : void* optional
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsPullBytes = webservices.NewProc("WsPullBytes")
)

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

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

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

let wspullbytes =
  foreign "WsPullBytes"
    ((ptr intptr_t) @-> (ptr void) @-> (ptr void) @-> (ptr intptr_t) @-> returning int32_t)
(* writer : WS_XML_WRITER* -> (ptr intptr_t) *)
(* callback : WS_PULL_BYTES_CALLBACK -> (ptr void) *)
(* callbackState : 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 ("WsPullBytes" ws-pull-bytes :convention :stdcall) :int32
  (writer :pointer)   ; WS_XML_WRITER*
  (callback :pointer)   ; WS_PULL_BYTES_CALLBACK
  (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 $WsPullBytes = Win32::API::More->new('webservices',
    'int WsPullBytes(LPVOID writer, LPVOID callback, LPVOID callbackState, LPVOID error)');
# my $ret = $WsPullBytes->Call($writer, $callback, $callbackState, $error);
# writer : WS_XML_WRITER* -> LPVOID
# callback : WS_PULL_BYTES_CALLBACK -> LPVOID
# callbackState : void* optional -> LPVOID
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型