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

WsSetOutput

関数
XMLライターの出力先を設定する。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsSetOutput(
    WS_XML_WRITER* writer,
    const WS_XML_WRITER_ENCODING* encoding,   // optional
    const WS_XML_WRITER_OUTPUT* output,   // optional
    const WS_XML_WRITER_PROPERTY* properties,   // optional
    DWORD propertyCount,
    WS_ERROR* error   // optional
);

パラメーター

名前方向説明
writerWS_XML_WRITER*in出力を設定する対象のXMLライター。
encodingWS_XML_WRITER_ENCODING*inoptional出力データのエンコーディングを指定する。
outputWS_XML_WRITER_OUTPUT*inoptional出力先(バッファ/ストリーム)を記述するWS_XML_WRITER_OUTPUT。
propertiesWS_XML_WRITER_PROPERTY*inoptionalライターの構成プロパティ配列。NULL可。
propertyCountDWORDinproperties配列の要素数。
errorWS_ERROR*inoptional失敗時の追加エラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsSetOutput(
    WS_XML_WRITER* writer,
    const WS_XML_WRITER_ENCODING* encoding,   // optional
    const WS_XML_WRITER_OUTPUT* output,   // optional
    const WS_XML_WRITER_PROPERTY* properties,   // optional
    DWORD propertyCount,
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsSetOutput(
    ref IntPtr writer,   // WS_XML_WRITER*
    IntPtr encoding,   // WS_XML_WRITER_ENCODING* optional
    IntPtr output,   // WS_XML_WRITER_OUTPUT* optional
    IntPtr properties,   // WS_XML_WRITER_PROPERTY* optional
    uint propertyCount,   // DWORD
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsSetOutput(
    ByRef writer As IntPtr,   ' WS_XML_WRITER*
    encoding As IntPtr,   ' WS_XML_WRITER_ENCODING* optional
    output As IntPtr,   ' WS_XML_WRITER_OUTPUT* optional
    properties As IntPtr,   ' WS_XML_WRITER_PROPERTY* optional
    propertyCount As UInteger,   ' DWORD
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' writer : WS_XML_WRITER*
' encoding : WS_XML_WRITER_ENCODING* optional
' output : WS_XML_WRITER_OUTPUT* optional
' properties : WS_XML_WRITER_PROPERTY* optional
' propertyCount : DWORD
' error : WS_ERROR* optional
Declare PtrSafe Function WsSetOutput Lib "webservices" ( _
    ByRef writer As LongPtr, _
    ByVal encoding As LongPtr, _
    ByVal output As LongPtr, _
    ByVal properties As LongPtr, _
    ByVal propertyCount 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

WsSetOutput = ctypes.windll.webservices.WsSetOutput
WsSetOutput.restype = ctypes.c_int
WsSetOutput.argtypes = [
    ctypes.c_void_p,  # writer : WS_XML_WRITER*
    ctypes.c_void_p,  # encoding : WS_XML_WRITER_ENCODING* optional
    ctypes.c_void_p,  # output : WS_XML_WRITER_OUTPUT* optional
    ctypes.c_void_p,  # properties : WS_XML_WRITER_PROPERTY* optional
    wintypes.DWORD,  # propertyCount : DWORD
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsSetOutput = webservices.NewProc("WsSetOutput")
)

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

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

foreign import stdcall safe "WsSetOutput"
  c_WsSetOutput :: Ptr CIntPtr -> Ptr () -> Ptr () -> Ptr () -> Word32 -> Ptr CIntPtr -> IO Int32
-- writer : WS_XML_WRITER* -> Ptr CIntPtr
-- encoding : WS_XML_WRITER_ENCODING* optional -> Ptr ()
-- output : WS_XML_WRITER_OUTPUT* optional -> Ptr ()
-- properties : WS_XML_WRITER_PROPERTY* optional -> Ptr ()
-- propertyCount : DWORD -> Word32
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wssetoutput =
  foreign "WsSetOutput"
    ((ptr intptr_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> (ptr intptr_t) @-> returning int32_t)
(* writer : WS_XML_WRITER* -> (ptr intptr_t) *)
(* encoding : WS_XML_WRITER_ENCODING* optional -> (ptr void) *)
(* output : WS_XML_WRITER_OUTPUT* optional -> (ptr void) *)
(* properties : WS_XML_WRITER_PROPERTY* optional -> (ptr void) *)
(* propertyCount : 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 ("WsSetOutput" ws-set-output :convention :stdcall) :int32
  (writer :pointer)   ; WS_XML_WRITER*
  (encoding :pointer)   ; WS_XML_WRITER_ENCODING* optional
  (output :pointer)   ; WS_XML_WRITER_OUTPUT* optional
  (properties :pointer)   ; WS_XML_WRITER_PROPERTY* optional
  (property-count :uint32)   ; DWORD
  (error :pointer))   ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsSetOutput = Win32::API::More->new('webservices',
    'int WsSetOutput(LPVOID writer, LPVOID encoding, LPVOID output, LPVOID properties, DWORD propertyCount, LPVOID error)');
# my $ret = $WsSetOutput->Call($writer, $encoding, $output, $properties, $propertyCount, $error);
# writer : WS_XML_WRITER* -> LPVOID
# encoding : WS_XML_WRITER_ENCODING* optional -> LPVOID
# output : WS_XML_WRITER_OUTPUT* optional -> LPVOID
# properties : WS_XML_WRITER_PROPERTY* optional -> LPVOID
# propertyCount : DWORD -> DWORD
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型