Win32 API 日本語リファレンス
ホームDevices.WebServicesOnDevices › WSDGenerateFaultEx

WSDGenerateFaultEx

関数
ローカライズ文字列付きのWSD SOAPフォルトを生成する。
DLLwsdapi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT WSDGenerateFaultEx(
    WSDXML_NAME* pCode,
    WSDXML_NAME* pSubCode,   // optional
    WSD_LOCALIZED_STRING_LIST* pReasons,
    LPCWSTR pszDetail,   // optional
    WSD_SOAP_FAULT** ppFault
);

パラメーター

名前方向説明
pCodeWSDXML_NAME*inフォルトコードを表すWSDXML_NAME(修飾名)へのポインタ。
pSubCodeWSDXML_NAME*inoptionalフォルトのサブコードを表すWSDXML_NAMEへのポインタ。NULL可。
pReasonsWSD_LOCALIZED_STRING_LIST*in言語別の理由文字列を格納したWSD_LOCALIZED_STRING_LISTへのポインタ。
pszDetailLPCWSTRinoptionalフォルトの詳細情報を表す文字列。NULL可。
ppFaultWSD_SOAP_FAULT**out生成されたWSD_SOAP_FAULT構造体を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WSDGenerateFaultEx(
    WSDXML_NAME* pCode,
    WSDXML_NAME* pSubCode,   // optional
    WSD_LOCALIZED_STRING_LIST* pReasons,
    LPCWSTR pszDetail,   // optional
    WSD_SOAP_FAULT** ppFault
);
[DllImport("wsdapi.dll", ExactSpelling = true)]
static extern int WSDGenerateFaultEx(
    IntPtr pCode,   // WSDXML_NAME*
    IntPtr pSubCode,   // WSDXML_NAME* optional
    IntPtr pReasons,   // WSD_LOCALIZED_STRING_LIST*
    [MarshalAs(UnmanagedType.LPWStr)] string pszDetail,   // LPCWSTR optional
    IntPtr ppFault   // WSD_SOAP_FAULT** out
);
<DllImport("wsdapi.dll", ExactSpelling:=True)>
Public Shared Function WSDGenerateFaultEx(
    pCode As IntPtr,   ' WSDXML_NAME*
    pSubCode As IntPtr,   ' WSDXML_NAME* optional
    pReasons As IntPtr,   ' WSD_LOCALIZED_STRING_LIST*
    <MarshalAs(UnmanagedType.LPWStr)> pszDetail As String,   ' LPCWSTR optional
    ppFault As IntPtr   ' WSD_SOAP_FAULT** out
) As Integer
End Function
' pCode : WSDXML_NAME*
' pSubCode : WSDXML_NAME* optional
' pReasons : WSD_LOCALIZED_STRING_LIST*
' pszDetail : LPCWSTR optional
' ppFault : WSD_SOAP_FAULT** out
Declare PtrSafe Function WSDGenerateFaultEx Lib "wsdapi" ( _
    ByVal pCode As LongPtr, _
    ByVal pSubCode As LongPtr, _
    ByVal pReasons As LongPtr, _
    ByVal pszDetail As LongPtr, _
    ByVal ppFault As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSDGenerateFaultEx = ctypes.windll.wsdapi.WSDGenerateFaultEx
WSDGenerateFaultEx.restype = ctypes.c_int
WSDGenerateFaultEx.argtypes = [
    ctypes.c_void_p,  # pCode : WSDXML_NAME*
    ctypes.c_void_p,  # pSubCode : WSDXML_NAME* optional
    ctypes.c_void_p,  # pReasons : WSD_LOCALIZED_STRING_LIST*
    wintypes.LPCWSTR,  # pszDetail : LPCWSTR optional
    ctypes.c_void_p,  # ppFault : WSD_SOAP_FAULT** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wsdapi.dll')
WSDGenerateFaultEx = Fiddle::Function.new(
  lib['WSDGenerateFaultEx'],
  [
    Fiddle::TYPE_VOIDP,  # pCode : WSDXML_NAME*
    Fiddle::TYPE_VOIDP,  # pSubCode : WSDXML_NAME* optional
    Fiddle::TYPE_VOIDP,  # pReasons : WSD_LOCALIZED_STRING_LIST*
    Fiddle::TYPE_VOIDP,  # pszDetail : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # ppFault : WSD_SOAP_FAULT** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wsdapi")]
extern "system" {
    fn WSDGenerateFaultEx(
        pCode: *mut WSDXML_NAME,  // WSDXML_NAME*
        pSubCode: *mut WSDXML_NAME,  // WSDXML_NAME* optional
        pReasons: *mut WSD_LOCALIZED_STRING_LIST,  // WSD_LOCALIZED_STRING_LIST*
        pszDetail: *const u16,  // LPCWSTR optional
        ppFault: *mut *mut WSD_SOAP_FAULT  // WSD_SOAP_FAULT** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wsdapi.dll")]
public static extern int WSDGenerateFaultEx(IntPtr pCode, IntPtr pSubCode, IntPtr pReasons, [MarshalAs(UnmanagedType.LPWStr)] string pszDetail, IntPtr ppFault);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wsdapi_WSDGenerateFaultEx' -Namespace Win32 -PassThru
# $api::WSDGenerateFaultEx(pCode, pSubCode, pReasons, pszDetail, ppFault)
#uselib "wsdapi.dll"
#func global WSDGenerateFaultEx "WSDGenerateFaultEx" sptr, sptr, sptr, sptr, sptr
; WSDGenerateFaultEx varptr(pCode), varptr(pSubCode), varptr(pReasons), pszDetail, varptr(ppFault)   ; 戻り値は stat
; pCode : WSDXML_NAME* -> "sptr"
; pSubCode : WSDXML_NAME* optional -> "sptr"
; pReasons : WSD_LOCALIZED_STRING_LIST* -> "sptr"
; pszDetail : LPCWSTR optional -> "sptr"
; ppFault : WSD_SOAP_FAULT** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "wsdapi.dll"
#cfunc global WSDGenerateFaultEx "WSDGenerateFaultEx" var, var, var, wstr, var
; res = WSDGenerateFaultEx(pCode, pSubCode, pReasons, pszDetail, ppFault)
; pCode : WSDXML_NAME* -> "var"
; pSubCode : WSDXML_NAME* optional -> "var"
; pReasons : WSD_LOCALIZED_STRING_LIST* -> "var"
; pszDetail : LPCWSTR optional -> "wstr"
; ppFault : WSD_SOAP_FAULT** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT WSDGenerateFaultEx(WSDXML_NAME* pCode, WSDXML_NAME* pSubCode, WSD_LOCALIZED_STRING_LIST* pReasons, LPCWSTR pszDetail, WSD_SOAP_FAULT** ppFault)
#uselib "wsdapi.dll"
#cfunc global WSDGenerateFaultEx "WSDGenerateFaultEx" var, var, var, wstr, var
; res = WSDGenerateFaultEx(pCode, pSubCode, pReasons, pszDetail, ppFault)
; pCode : WSDXML_NAME* -> "var"
; pSubCode : WSDXML_NAME* optional -> "var"
; pReasons : WSD_LOCALIZED_STRING_LIST* -> "var"
; pszDetail : LPCWSTR optional -> "wstr"
; ppFault : WSD_SOAP_FAULT** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wsdapi = windows.NewLazySystemDLL("wsdapi.dll")
	procWSDGenerateFaultEx = wsdapi.NewProc("WSDGenerateFaultEx")
)

// pCode (WSDXML_NAME*), pSubCode (WSDXML_NAME* optional), pReasons (WSD_LOCALIZED_STRING_LIST*), pszDetail (LPCWSTR optional), ppFault (WSD_SOAP_FAULT** out)
r1, _, err := procWSDGenerateFaultEx.Call(
	uintptr(pCode),
	uintptr(pSubCode),
	uintptr(pReasons),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszDetail))),
	uintptr(ppFault),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WSDGenerateFaultEx(
  pCode: Pointer;   // WSDXML_NAME*
  pSubCode: Pointer;   // WSDXML_NAME* optional
  pReasons: Pointer;   // WSD_LOCALIZED_STRING_LIST*
  pszDetail: PWideChar;   // LPCWSTR optional
  ppFault: Pointer   // WSD_SOAP_FAULT** out
): Integer; stdcall;
  external 'wsdapi.dll' name 'WSDGenerateFaultEx';
result := DllCall("wsdapi\WSDGenerateFaultEx"
    , "Ptr", pCode   ; WSDXML_NAME*
    , "Ptr", pSubCode   ; WSDXML_NAME* optional
    , "Ptr", pReasons   ; WSD_LOCALIZED_STRING_LIST*
    , "WStr", pszDetail   ; LPCWSTR optional
    , "Ptr", ppFault   ; WSD_SOAP_FAULT** out
    , "Int")   ; return: HRESULT
●WSDGenerateFaultEx(pCode, pSubCode, pReasons, pszDetail, ppFault) = DLL("wsdapi.dll", "int WSDGenerateFaultEx(void*, void*, void*, char*, void*)")
# 呼び出し: WSDGenerateFaultEx(pCode, pSubCode, pReasons, pszDetail, ppFault)
# pCode : WSDXML_NAME* -> "void*"
# pSubCode : WSDXML_NAME* optional -> "void*"
# pReasons : WSD_LOCALIZED_STRING_LIST* -> "void*"
# pszDetail : LPCWSTR optional -> "char*"
# ppFault : WSD_SOAP_FAULT** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wsdapi" fn WSDGenerateFaultEx(
    pCode: [*c]WSDXML_NAME, // WSDXML_NAME*
    pSubCode: [*c]WSDXML_NAME, // WSDXML_NAME* optional
    pReasons: [*c]WSD_LOCALIZED_STRING_LIST, // WSD_LOCALIZED_STRING_LIST*
    pszDetail: [*c]const u16, // LPCWSTR optional
    ppFault: [*c][*c]WSD_SOAP_FAULT // WSD_SOAP_FAULT** out
) callconv(std.os.windows.WINAPI) i32;
proc WSDGenerateFaultEx(
    pCode: ptr WSDXML_NAME,  # WSDXML_NAME*
    pSubCode: ptr WSDXML_NAME,  # WSDXML_NAME* optional
    pReasons: ptr WSD_LOCALIZED_STRING_LIST,  # WSD_LOCALIZED_STRING_LIST*
    pszDetail: WideCString,  # LPCWSTR optional
    ppFault: ptr WSD_SOAP_FAULT  # WSD_SOAP_FAULT** out
): int32 {.importc: "WSDGenerateFaultEx", stdcall, dynlib: "wsdapi.dll".}
pragma(lib, "wsdapi");
extern(Windows)
int WSDGenerateFaultEx(
    WSDXML_NAME* pCode,   // WSDXML_NAME*
    WSDXML_NAME* pSubCode,   // WSDXML_NAME* optional
    WSD_LOCALIZED_STRING_LIST* pReasons,   // WSD_LOCALIZED_STRING_LIST*
    const(wchar)* pszDetail,   // LPCWSTR optional
    WSD_SOAP_FAULT** ppFault   // WSD_SOAP_FAULT** out
);
ccall((:WSDGenerateFaultEx, "wsdapi.dll"), stdcall, Int32,
      (Ptr{WSDXML_NAME}, Ptr{WSDXML_NAME}, Ptr{WSD_LOCALIZED_STRING_LIST}, Cwstring, Ptr{WSD_SOAP_FAULT}),
      pCode, pSubCode, pReasons, pszDetail, ppFault)
# pCode : WSDXML_NAME* -> Ptr{WSDXML_NAME}
# pSubCode : WSDXML_NAME* optional -> Ptr{WSDXML_NAME}
# pReasons : WSD_LOCALIZED_STRING_LIST* -> Ptr{WSD_LOCALIZED_STRING_LIST}
# pszDetail : LPCWSTR optional -> Cwstring
# ppFault : WSD_SOAP_FAULT** out -> Ptr{WSD_SOAP_FAULT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSDGenerateFaultEx(
    void* pCode,
    void* pSubCode,
    void* pReasons,
    const uint16_t* pszDetail,
    void* ppFault);
]]
local wsdapi = ffi.load("wsdapi")
-- wsdapi.WSDGenerateFaultEx(pCode, pSubCode, pReasons, pszDetail, ppFault)
-- pCode : WSDXML_NAME*
-- pSubCode : WSDXML_NAME* optional
-- pReasons : WSD_LOCALIZED_STRING_LIST*
-- pszDetail : LPCWSTR optional
-- ppFault : WSD_SOAP_FAULT** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wsdapi.dll');
const WSDGenerateFaultEx = lib.func('__stdcall', 'WSDGenerateFaultEx', 'int32_t', ['void *', 'void *', 'void *', 'str16', 'void *']);
// WSDGenerateFaultEx(pCode, pSubCode, pReasons, pszDetail, ppFault)
// pCode : WSDXML_NAME* -> 'void *'
// pSubCode : WSDXML_NAME* optional -> 'void *'
// pReasons : WSD_LOCALIZED_STRING_LIST* -> 'void *'
// pszDetail : LPCWSTR optional -> 'str16'
// ppFault : WSD_SOAP_FAULT** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wsdapi.dll", {
  WSDGenerateFaultEx: { parameters: ["pointer", "pointer", "pointer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.WSDGenerateFaultEx(pCode, pSubCode, pReasons, pszDetail, ppFault)
// pCode : WSDXML_NAME* -> "pointer"
// pSubCode : WSDXML_NAME* optional -> "pointer"
// pReasons : WSD_LOCALIZED_STRING_LIST* -> "pointer"
// pszDetail : LPCWSTR optional -> "buffer"
// ppFault : WSD_SOAP_FAULT** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSDGenerateFaultEx(
    void* pCode,
    void* pSubCode,
    void* pReasons,
    const uint16_t* pszDetail,
    void* ppFault);
C, "wsdapi.dll");
// $ffi->WSDGenerateFaultEx(pCode, pSubCode, pReasons, pszDetail, ppFault);
// pCode : WSDXML_NAME*
// pSubCode : WSDXML_NAME* optional
// pReasons : WSD_LOCALIZED_STRING_LIST*
// pszDetail : LPCWSTR optional
// ppFault : WSD_SOAP_FAULT** out
// 構造体/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 Wsdapi extends StdCallLibrary {
    Wsdapi INSTANCE = Native.load("wsdapi", Wsdapi.class);
    int WSDGenerateFaultEx(
        Pointer pCode,   // WSDXML_NAME*
        Pointer pSubCode,   // WSDXML_NAME* optional
        Pointer pReasons,   // WSD_LOCALIZED_STRING_LIST*
        WString pszDetail,   // LPCWSTR optional
        Pointer ppFault   // WSD_SOAP_FAULT** out
    );
}
@[Link("wsdapi")]
lib Libwsdapi
  fun WSDGenerateFaultEx = WSDGenerateFaultEx(
    pCode : WSDXML_NAME*,   # WSDXML_NAME*
    pSubCode : WSDXML_NAME*,   # WSDXML_NAME* optional
    pReasons : WSD_LOCALIZED_STRING_LIST*,   # WSD_LOCALIZED_STRING_LIST*
    pszDetail : UInt16*,   # LPCWSTR optional
    ppFault : WSD_SOAP_FAULT**   # WSD_SOAP_FAULT** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSDGenerateFaultExNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Void>);
typedef WSDGenerateFaultExDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Void>);
final WSDGenerateFaultEx = DynamicLibrary.open('wsdapi.dll')
    .lookupFunction<WSDGenerateFaultExNative, WSDGenerateFaultExDart>('WSDGenerateFaultEx');
// pCode : WSDXML_NAME* -> Pointer<Void>
// pSubCode : WSDXML_NAME* optional -> Pointer<Void>
// pReasons : WSD_LOCALIZED_STRING_LIST* -> Pointer<Void>
// pszDetail : LPCWSTR optional -> Pointer<Utf16>
// ppFault : WSD_SOAP_FAULT** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSDGenerateFaultEx(
  pCode: Pointer;   // WSDXML_NAME*
  pSubCode: Pointer;   // WSDXML_NAME* optional
  pReasons: Pointer;   // WSD_LOCALIZED_STRING_LIST*
  pszDetail: PWideChar;   // LPCWSTR optional
  ppFault: Pointer   // WSD_SOAP_FAULT** out
): Integer; stdcall;
  external 'wsdapi.dll' name 'WSDGenerateFaultEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSDGenerateFaultEx"
  c_WSDGenerateFaultEx :: Ptr () -> Ptr () -> Ptr () -> CWString -> Ptr () -> IO Int32
-- pCode : WSDXML_NAME* -> Ptr ()
-- pSubCode : WSDXML_NAME* optional -> Ptr ()
-- pReasons : WSD_LOCALIZED_STRING_LIST* -> Ptr ()
-- pszDetail : LPCWSTR optional -> CWString
-- ppFault : WSD_SOAP_FAULT** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsdgeneratefaultex =
  foreign "WSDGenerateFaultEx"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* pCode : WSDXML_NAME* -> (ptr void) *)
(* pSubCode : WSDXML_NAME* optional -> (ptr void) *)
(* pReasons : WSD_LOCALIZED_STRING_LIST* -> (ptr void) *)
(* pszDetail : LPCWSTR optional -> (ptr uint16_t) *)
(* ppFault : WSD_SOAP_FAULT** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wsdapi (t "wsdapi.dll"))
(cffi:use-foreign-library wsdapi)

(cffi:defcfun ("WSDGenerateFaultEx" wsdgenerate-fault-ex :convention :stdcall) :int32
  (p-code :pointer)   ; WSDXML_NAME*
  (p-sub-code :pointer)   ; WSDXML_NAME* optional
  (p-reasons :pointer)   ; WSD_LOCALIZED_STRING_LIST*
  (psz-detail (:string :encoding :utf-16le))   ; LPCWSTR optional
  (pp-fault :pointer))   ; WSD_SOAP_FAULT** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSDGenerateFaultEx = Win32::API::More->new('wsdapi',
    'int WSDGenerateFaultEx(LPVOID pCode, LPVOID pSubCode, LPVOID pReasons, LPCWSTR pszDetail, LPVOID ppFault)');
# my $ret = $WSDGenerateFaultEx->Call($pCode, $pSubCode, $pReasons, $pszDetail, $ppFault);
# pCode : WSDXML_NAME* -> LPVOID
# pSubCode : WSDXML_NAME* optional -> LPVOID
# pReasons : WSD_LOCALIZED_STRING_LIST* -> LPVOID
# pszDetail : LPCWSTR optional -> LPCWSTR
# ppFault : WSD_SOAP_FAULT** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型