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

WSDGenerateFault

関数
コードや理由からWSD SOAPフォルト構造体を生成する。
DLLwsdapi.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT WSDGenerateFault(
    LPCWSTR pszCode,
    LPCWSTR pszSubCode,   // optional
    LPCWSTR pszReason,
    LPCWSTR pszDetail,   // optional
    IWSDXMLContext* pContext,
    WSD_SOAP_FAULT** ppFault
);

パラメーター

名前型方向説明
pszCodeLPCWSTRinSOAPフォルトのコード値を表す文字列。
pszSubCodeLPCWSTRinoptionalフォルトのサブコード値を表す文字列。NULL可。
pszReasonLPCWSTRin人間可読の理由文字列。
pszDetailLPCWSTRinoptionalフォルトの詳細情報を表す文字列。NULL可。
pContextIWSDXMLContext*in名前空間解決などに用いるIWSDXMLContextインターフェイスへのポインタ。
ppFaultWSD_SOAP_FAULT**out生成されたWSD_SOAP_FAULT構造体を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WSDGenerateFault(
    LPCWSTR pszCode,
    LPCWSTR pszSubCode,   // optional
    LPCWSTR pszReason,
    LPCWSTR pszDetail,   // optional
    IWSDXMLContext* pContext,
    WSD_SOAP_FAULT** ppFault
);
[DllImport("wsdapi.dll", ExactSpelling = true)]
static extern int WSDGenerateFault(
    [MarshalAs(UnmanagedType.LPWStr)] string pszCode,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszSubCode,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszReason,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszDetail,   // LPCWSTR optional
    IntPtr pContext,   // IWSDXMLContext*
    IntPtr ppFault   // WSD_SOAP_FAULT** out
);
<DllImport("wsdapi.dll", ExactSpelling:=True)>
Public Shared Function WSDGenerateFault(
    <MarshalAs(UnmanagedType.LPWStr)> pszCode As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszSubCode As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> pszReason As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszDetail As String,   ' LPCWSTR optional
    pContext As IntPtr,   ' IWSDXMLContext*
    ppFault As IntPtr   ' WSD_SOAP_FAULT** out
) As Integer
End Function
' pszCode : LPCWSTR
' pszSubCode : LPCWSTR optional
' pszReason : LPCWSTR
' pszDetail : LPCWSTR optional
' pContext : IWSDXMLContext*
' ppFault : WSD_SOAP_FAULT** out
Declare PtrSafe Function WSDGenerateFault Lib "wsdapi" ( _
    ByVal pszCode As LongPtr, _
    ByVal pszSubCode As LongPtr, _
    ByVal pszReason As LongPtr, _
    ByVal pszDetail As LongPtr, _
    ByVal pContext 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

WSDGenerateFault = ctypes.windll.wsdapi.WSDGenerateFault
WSDGenerateFault.restype = ctypes.c_int
WSDGenerateFault.argtypes = [
    wintypes.LPCWSTR,  # pszCode : LPCWSTR
    wintypes.LPCWSTR,  # pszSubCode : LPCWSTR optional
    wintypes.LPCWSTR,  # pszReason : LPCWSTR
    wintypes.LPCWSTR,  # pszDetail : LPCWSTR optional
    ctypes.c_void_p,  # pContext : IWSDXMLContext*
    ctypes.c_void_p,  # ppFault : WSD_SOAP_FAULT** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wsdapi.dll')
WSDGenerateFault = Fiddle::Function.new(
  lib['WSDGenerateFault'],
  [
    Fiddle::TYPE_VOIDP,  # pszCode : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszSubCode : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pszReason : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszDetail : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pContext : IWSDXMLContext*
    Fiddle::TYPE_VOIDP,  # ppFault : WSD_SOAP_FAULT** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wsdapi")]
extern "system" {
    fn WSDGenerateFault(
        pszCode: *const u16,  // LPCWSTR
        pszSubCode: *const u16,  // LPCWSTR optional
        pszReason: *const u16,  // LPCWSTR
        pszDetail: *const u16,  // LPCWSTR optional
        pContext: *mut core::ffi::c_void,  // IWSDXMLContext*
        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 WSDGenerateFault([MarshalAs(UnmanagedType.LPWStr)] string pszCode, [MarshalAs(UnmanagedType.LPWStr)] string pszSubCode, [MarshalAs(UnmanagedType.LPWStr)] string pszReason, [MarshalAs(UnmanagedType.LPWStr)] string pszDetail, IntPtr pContext, IntPtr ppFault);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wsdapi_WSDGenerateFault' -Namespace Win32 -PassThru
# $api::WSDGenerateFault(pszCode, pszSubCode, pszReason, pszDetail, pContext, ppFault)
#uselib "wsdapi.dll"
#func global WSDGenerateFault "WSDGenerateFault" sptr, sptr, sptr, sptr, sptr, sptr
; WSDGenerateFault pszCode, pszSubCode, pszReason, pszDetail, pContext, varptr(ppFault)   ; 戻り値は stat
; pszCode : LPCWSTR -> "sptr"
; pszSubCode : LPCWSTR optional -> "sptr"
; pszReason : LPCWSTR -> "sptr"
; pszDetail : LPCWSTR optional -> "sptr"
; pContext : IWSDXMLContext* -> "sptr"
; ppFault : WSD_SOAP_FAULT** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "wsdapi.dll"
#cfunc global WSDGenerateFault "WSDGenerateFault" wstr, wstr, wstr, wstr, sptr, var
; res = WSDGenerateFault(pszCode, pszSubCode, pszReason, pszDetail, pContext, ppFault)
; pszCode : LPCWSTR -> "wstr"
; pszSubCode : LPCWSTR optional -> "wstr"
; pszReason : LPCWSTR -> "wstr"
; pszDetail : LPCWSTR optional -> "wstr"
; pContext : IWSDXMLContext* -> "sptr"
; ppFault : WSD_SOAP_FAULT** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT WSDGenerateFault(LPCWSTR pszCode, LPCWSTR pszSubCode, LPCWSTR pszReason, LPCWSTR pszDetail, IWSDXMLContext* pContext, WSD_SOAP_FAULT** ppFault)
#uselib "wsdapi.dll"
#cfunc global WSDGenerateFault "WSDGenerateFault" wstr, wstr, wstr, wstr, intptr, var
; res = WSDGenerateFault(pszCode, pszSubCode, pszReason, pszDetail, pContext, ppFault)
; pszCode : LPCWSTR -> "wstr"
; pszSubCode : LPCWSTR optional -> "wstr"
; pszReason : LPCWSTR -> "wstr"
; pszDetail : LPCWSTR optional -> "wstr"
; pContext : IWSDXMLContext* -> "intptr"
; ppFault : WSD_SOAP_FAULT** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wsdapi = windows.NewLazySystemDLL("wsdapi.dll")
	procWSDGenerateFault = wsdapi.NewProc("WSDGenerateFault")
)

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

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

foreign import stdcall safe "WSDGenerateFault"
  c_WSDGenerateFault :: CWString -> CWString -> CWString -> CWString -> Ptr () -> Ptr () -> IO Int32
-- pszCode : LPCWSTR -> CWString
-- pszSubCode : LPCWSTR optional -> CWString
-- pszReason : LPCWSTR -> CWString
-- pszDetail : LPCWSTR optional -> CWString
-- pContext : IWSDXMLContext* -> Ptr ()
-- ppFault : WSD_SOAP_FAULT** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsdgeneratefault =
  foreign "WSDGenerateFault"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pszCode : LPCWSTR -> (ptr uint16_t) *)
(* pszSubCode : LPCWSTR optional -> (ptr uint16_t) *)
(* pszReason : LPCWSTR -> (ptr uint16_t) *)
(* pszDetail : LPCWSTR optional -> (ptr uint16_t) *)
(* pContext : IWSDXMLContext* -> (ptr void) *)
(* 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 ("WSDGenerateFault" wsdgenerate-fault :convention :stdcall) :int32
  (psz-code (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-sub-code (:string :encoding :utf-16le))   ; LPCWSTR optional
  (psz-reason (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-detail (:string :encoding :utf-16le))   ; LPCWSTR optional
  (p-context :pointer)   ; IWSDXMLContext*
  (pp-fault :pointer))   ; WSD_SOAP_FAULT** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSDGenerateFault = Win32::API::More->new('wsdapi',
    'int WSDGenerateFault(LPCWSTR pszCode, LPCWSTR pszSubCode, LPCWSTR pszReason, LPCWSTR pszDetail, LPVOID pContext, LPVOID ppFault)');
# my $ret = $WSDGenerateFault->Call($pszCode, $pszSubCode, $pszReason, $pszDetail, $pContext, $ppFault);
# pszCode : LPCWSTR -> LPCWSTR
# pszSubCode : LPCWSTR optional -> LPCWSTR
# pszReason : LPCWSTR -> LPCWSTR
# pszDetail : LPCWSTR optional -> LPCWSTR
# pContext : IWSDXMLContext* -> LPVOID
# ppFault : WSD_SOAP_FAULT** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型