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

WsReadToStartElement

関数
指定した名前のXML開始要素まで読み進める。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsReadToStartElement(
    WS_XML_READER* reader,
    const WS_XML_STRING* localName,   // optional
    const WS_XML_STRING* ns,   // optional
    BOOL* found,   // optional
    WS_ERROR* error   // optional
);

パラメーター

名前方向説明
readerWS_XML_READER*in対象のXMLリーダー。
localNameWS_XML_STRING*inoptional探す要素のローカル名。NULLなら任意の開始要素。
nsWS_XML_STRING*inoptional探す要素の名前空間URI。NULLなら名前空間を問わない。
foundBOOL*outoptional指定要素が見つかったか否かを受け取る出力。NULL可。
errorWS_ERROR*inoptional失敗時の追加エラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsReadToStartElement(
    WS_XML_READER* reader,
    const WS_XML_STRING* localName,   // optional
    const WS_XML_STRING* ns,   // optional
    BOOL* found,   // optional
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsReadToStartElement(
    ref IntPtr reader,   // WS_XML_READER*
    IntPtr localName,   // WS_XML_STRING* optional
    IntPtr ns,   // WS_XML_STRING* optional
    IntPtr found,   // BOOL* optional, out
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsReadToStartElement(
    ByRef reader As IntPtr,   ' WS_XML_READER*
    localName As IntPtr,   ' WS_XML_STRING* optional
    ns As IntPtr,   ' WS_XML_STRING* optional
    found As IntPtr,   ' BOOL* optional, out
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' reader : WS_XML_READER*
' localName : WS_XML_STRING* optional
' ns : WS_XML_STRING* optional
' found : BOOL* optional, out
' error : WS_ERROR* optional
Declare PtrSafe Function WsReadToStartElement Lib "webservices" ( _
    ByRef reader As LongPtr, _
    ByVal localName As LongPtr, _
    ByVal ns As LongPtr, _
    ByVal found 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

WsReadToStartElement = ctypes.windll.webservices.WsReadToStartElement
WsReadToStartElement.restype = ctypes.c_int
WsReadToStartElement.argtypes = [
    ctypes.c_void_p,  # reader : WS_XML_READER*
    ctypes.c_void_p,  # localName : WS_XML_STRING* optional
    ctypes.c_void_p,  # ns : WS_XML_STRING* optional
    ctypes.c_void_p,  # found : BOOL* optional, out
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsReadToStartElement = webservices.NewProc("WsReadToStartElement")
)

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

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

foreign import stdcall safe "WsReadToStartElement"
  c_WsReadToStartElement :: Ptr CIntPtr -> Ptr () -> Ptr () -> Ptr CInt -> Ptr CIntPtr -> IO Int32
-- reader : WS_XML_READER* -> Ptr CIntPtr
-- localName : WS_XML_STRING* optional -> Ptr ()
-- ns : WS_XML_STRING* optional -> Ptr ()
-- found : BOOL* optional, out -> Ptr CInt
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsreadtostartelement =
  foreign "WsReadToStartElement"
    ((ptr intptr_t) @-> (ptr void) @-> (ptr void) @-> (ptr int32_t) @-> (ptr intptr_t) @-> returning int32_t)
(* reader : WS_XML_READER* -> (ptr intptr_t) *)
(* localName : WS_XML_STRING* optional -> (ptr void) *)
(* ns : WS_XML_STRING* optional -> (ptr void) *)
(* found : BOOL* optional, out -> (ptr int32_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 ("WsReadToStartElement" ws-read-to-start-element :convention :stdcall) :int32
  (reader :pointer)   ; WS_XML_READER*
  (local-name :pointer)   ; WS_XML_STRING* optional
  (ns :pointer)   ; WS_XML_STRING* optional
  (found :pointer)   ; BOOL* optional, out
  (error :pointer))   ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsReadToStartElement = Win32::API::More->new('webservices',
    'int WsReadToStartElement(LPVOID reader, LPVOID localName, LPVOID ns, LPVOID found, LPVOID error)');
# my $ret = $WsReadToStartElement->Call($reader, $localName, $ns, $found, $error);
# reader : WS_XML_READER* -> LPVOID
# localName : WS_XML_STRING* optional -> LPVOID
# ns : WS_XML_STRING* optional -> LPVOID
# found : BOOL* optional, out -> LPVOID
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型