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

WsGetDictionary

関数
エンコーディングに対応するXML辞書を取得する。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsGetDictionary(
    WS_ENCODING encoding,
    WS_XML_DICTIONARY** dictionary,
    WS_ERROR* error   // optional
);

パラメーター

名前方向説明
encodingWS_ENCODINGin対象とするエンコーディングを示すWS_ENCODING列挙値。
dictionaryWS_XML_DICTIONARY**out対応する組み込み文字列辞書WS_XML_DICTIONARYを受け取る出力。
errorWS_ERROR*inoptional失敗時の追加エラー情報を格納するWS_ERRORオブジェクト。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsGetDictionary(
    WS_ENCODING encoding,
    WS_XML_DICTIONARY** dictionary,
    WS_ERROR* error   // optional
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsGetDictionary(
    int encoding,   // WS_ENCODING
    IntPtr dictionary,   // WS_XML_DICTIONARY** out
    IntPtr error   // WS_ERROR* optional
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsGetDictionary(
    encoding As Integer,   ' WS_ENCODING
    dictionary As IntPtr,   ' WS_XML_DICTIONARY** out
    [error] As IntPtr   ' WS_ERROR* optional
) As Integer
End Function
' encoding : WS_ENCODING
' dictionary : WS_XML_DICTIONARY** out
' error : WS_ERROR* optional
Declare PtrSafe Function WsGetDictionary Lib "webservices" ( _
    ByVal encoding As Long, _
    ByVal dictionary 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

WsGetDictionary = ctypes.windll.webservices.WsGetDictionary
WsGetDictionary.restype = ctypes.c_int
WsGetDictionary.argtypes = [
    ctypes.c_int,  # encoding : WS_ENCODING
    ctypes.c_void_p,  # dictionary : WS_XML_DICTIONARY** out
    ctypes.c_void_p,  # error : WS_ERROR* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsGetDictionary = webservices.NewProc("WsGetDictionary")
)

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

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

foreign import stdcall safe "WsGetDictionary"
  c_WsGetDictionary :: Int32 -> Ptr () -> Ptr CIntPtr -> IO Int32
-- encoding : WS_ENCODING -> Int32
-- dictionary : WS_XML_DICTIONARY** out -> Ptr ()
-- error : WS_ERROR* optional -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsgetdictionary =
  foreign "WsGetDictionary"
    (int32_t @-> (ptr void) @-> (ptr intptr_t) @-> returning int32_t)
(* encoding : WS_ENCODING -> int32_t *)
(* dictionary : WS_XML_DICTIONARY** out -> (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 ("WsGetDictionary" ws-get-dictionary :convention :stdcall) :int32
  (encoding :int32)   ; WS_ENCODING
  (dictionary :pointer)   ; WS_XML_DICTIONARY** out
  (error :pointer))   ; WS_ERROR* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsGetDictionary = Win32::API::More->new('webservices',
    'int WsGetDictionary(int encoding, LPVOID dictionary, LPVOID error)');
# my $ret = $WsGetDictionary->Call($encoding, $dictionary, $error);
# encoding : WS_ENCODING -> int
# dictionary : WS_XML_DICTIONARY** out -> LPVOID
# error : WS_ERROR* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型