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

WsSetFaultErrorDetail

関数
フォルトエラーの詳細情報を設定する。
DLLwebservices.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT WsSetFaultErrorDetail(
    WS_ERROR* error,
    const WS_FAULT_DETAIL_DESCRIPTION* faultDetailDescription,
    WS_WRITE_OPTION writeOption,
    const void* value,   // optional
    DWORD valueSize
);

パラメーター

名前方向説明
errorWS_ERROR*in詳細を設定する対象のWS_ERRORオブジェクト。
faultDetailDescriptionWS_FAULT_DETAIL_DESCRIPTION*inフォールト詳細要素のスキーマを記述するWS_FAULT_DETAIL_DESCRIPTION。
writeOptionWS_WRITE_OPTIONin詳細値の書き込み方法を示す列挙値。
valuevoid*inoptional設定する詳細値データへのポインタ。
valueSizeDWORDinvalueのバイトサイズ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WsSetFaultErrorDetail(
    WS_ERROR* error,
    const WS_FAULT_DETAIL_DESCRIPTION* faultDetailDescription,
    WS_WRITE_OPTION writeOption,
    const void* value,   // optional
    DWORD valueSize
);
[DllImport("webservices.dll", ExactSpelling = true)]
static extern int WsSetFaultErrorDetail(
    ref IntPtr error,   // WS_ERROR*
    IntPtr faultDetailDescription,   // WS_FAULT_DETAIL_DESCRIPTION*
    int writeOption,   // WS_WRITE_OPTION
    IntPtr value,   // void* optional
    uint valueSize   // DWORD
);
<DllImport("webservices.dll", ExactSpelling:=True)>
Public Shared Function WsSetFaultErrorDetail(
    ByRef [error] As IntPtr,   ' WS_ERROR*
    faultDetailDescription As IntPtr,   ' WS_FAULT_DETAIL_DESCRIPTION*
    writeOption As Integer,   ' WS_WRITE_OPTION
    value As IntPtr,   ' void* optional
    valueSize As UInteger   ' DWORD
) As Integer
End Function
' error : WS_ERROR*
' faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION*
' writeOption : WS_WRITE_OPTION
' value : void* optional
' valueSize : DWORD
Declare PtrSafe Function WsSetFaultErrorDetail Lib "webservices" ( _
    ByRef error As LongPtr, _
    ByVal faultDetailDescription As LongPtr, _
    ByVal writeOption As Long, _
    ByVal value As LongPtr, _
    ByVal valueSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WsSetFaultErrorDetail = ctypes.windll.webservices.WsSetFaultErrorDetail
WsSetFaultErrorDetail.restype = ctypes.c_int
WsSetFaultErrorDetail.argtypes = [
    ctypes.c_void_p,  # error : WS_ERROR*
    ctypes.c_void_p,  # faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION*
    ctypes.c_int,  # writeOption : WS_WRITE_OPTION
    ctypes.POINTER(None),  # value : void* optional
    wintypes.DWORD,  # valueSize : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('webservices.dll')
WsSetFaultErrorDetail = Fiddle::Function.new(
  lib['WsSetFaultErrorDetail'],
  [
    Fiddle::TYPE_VOIDP,  # error : WS_ERROR*
    Fiddle::TYPE_VOIDP,  # faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION*
    Fiddle::TYPE_INT,  # writeOption : WS_WRITE_OPTION
    Fiddle::TYPE_VOIDP,  # value : void* optional
    -Fiddle::TYPE_INT,  # valueSize : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "webservices")]
extern "system" {
    fn WsSetFaultErrorDetail(
        error: *mut isize,  // WS_ERROR*
        faultDetailDescription: *const WS_FAULT_DETAIL_DESCRIPTION,  // WS_FAULT_DETAIL_DESCRIPTION*
        writeOption: i32,  // WS_WRITE_OPTION
        value: *const (),  // void* optional
        valueSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("webservices.dll")]
public static extern int WsSetFaultErrorDetail(ref IntPtr error, IntPtr faultDetailDescription, int writeOption, IntPtr value, uint valueSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'webservices_WsSetFaultErrorDetail' -Namespace Win32 -PassThru
# $api::WsSetFaultErrorDetail(error, faultDetailDescription, writeOption, value, valueSize)
#uselib "webservices.dll"
#func global WsSetFaultErrorDetail "WsSetFaultErrorDetail" sptr, sptr, sptr, sptr, sptr
; WsSetFaultErrorDetail varptr(error), varptr(faultDetailDescription), writeOption, value, valueSize   ; 戻り値は stat
; error : WS_ERROR* -> "sptr"
; faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> "sptr"
; writeOption : WS_WRITE_OPTION -> "sptr"
; value : void* optional -> "sptr"
; valueSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "webservices.dll"
#cfunc global WsSetFaultErrorDetail "WsSetFaultErrorDetail" var, var, int, sptr, int
; res = WsSetFaultErrorDetail(error, faultDetailDescription, writeOption, value, valueSize)
; error : WS_ERROR* -> "var"
; faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> "var"
; writeOption : WS_WRITE_OPTION -> "int"
; value : void* optional -> "sptr"
; valueSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT WsSetFaultErrorDetail(WS_ERROR* error, WS_FAULT_DETAIL_DESCRIPTION* faultDetailDescription, WS_WRITE_OPTION writeOption, void* value, DWORD valueSize)
#uselib "webservices.dll"
#cfunc global WsSetFaultErrorDetail "WsSetFaultErrorDetail" var, var, int, intptr, int
; res = WsSetFaultErrorDetail(error, faultDetailDescription, writeOption, value, valueSize)
; error : WS_ERROR* -> "var"
; faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> "var"
; writeOption : WS_WRITE_OPTION -> "int"
; value : void* optional -> "intptr"
; valueSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	webservices = windows.NewLazySystemDLL("webservices.dll")
	procWsSetFaultErrorDetail = webservices.NewProc("WsSetFaultErrorDetail")
)

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

extern "webservices" fn WsSetFaultErrorDetail(
    error: [*c]isize, // WS_ERROR*
    faultDetailDescription: [*c]WS_FAULT_DETAIL_DESCRIPTION, // WS_FAULT_DETAIL_DESCRIPTION*
    writeOption: i32, // WS_WRITE_OPTION
    value: ?*anyopaque, // void* optional
    valueSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc WsSetFaultErrorDetail(
    error: ptr int,  # WS_ERROR*
    faultDetailDescription: ptr WS_FAULT_DETAIL_DESCRIPTION,  # WS_FAULT_DETAIL_DESCRIPTION*
    writeOption: int32,  # WS_WRITE_OPTION
    value: pointer,  # void* optional
    valueSize: uint32  # DWORD
): int32 {.importc: "WsSetFaultErrorDetail", stdcall, dynlib: "webservices.dll".}
pragma(lib, "webservices");
extern(Windows)
int WsSetFaultErrorDetail(
    ptrdiff_t* error,   // WS_ERROR*
    WS_FAULT_DETAIL_DESCRIPTION* faultDetailDescription,   // WS_FAULT_DETAIL_DESCRIPTION*
    int writeOption,   // WS_WRITE_OPTION
    void* value,   // void* optional
    uint valueSize   // DWORD
);
ccall((:WsSetFaultErrorDetail, "webservices.dll"), stdcall, Int32,
      (Ptr{Int}, Ptr{WS_FAULT_DETAIL_DESCRIPTION}, Int32, Ptr{Cvoid}, UInt32),
      error, faultDetailDescription, writeOption, value, valueSize)
# error : WS_ERROR* -> Ptr{Int}
# faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> Ptr{WS_FAULT_DETAIL_DESCRIPTION}
# writeOption : WS_WRITE_OPTION -> Int32
# value : void* optional -> Ptr{Cvoid}
# valueSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WsSetFaultErrorDetail(
    intptr_t* error,
    void* faultDetailDescription,
    int32_t writeOption,
    void* value,
    uint32_t valueSize);
]]
local webservices = ffi.load("webservices")
-- webservices.WsSetFaultErrorDetail(error, faultDetailDescription, writeOption, value, valueSize)
-- error : WS_ERROR*
-- faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION*
-- writeOption : WS_WRITE_OPTION
-- value : void* optional
-- valueSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('webservices.dll');
const WsSetFaultErrorDetail = lib.func('__stdcall', 'WsSetFaultErrorDetail', 'int32_t', ['intptr_t *', 'void *', 'int32_t', 'void *', 'uint32_t']);
// WsSetFaultErrorDetail(error, faultDetailDescription, writeOption, value, valueSize)
// error : WS_ERROR* -> 'intptr_t *'
// faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> 'void *'
// writeOption : WS_WRITE_OPTION -> 'int32_t'
// value : void* optional -> 'void *'
// valueSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("webservices.dll", {
  WsSetFaultErrorDetail: { parameters: ["pointer", "pointer", "i32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.WsSetFaultErrorDetail(error, faultDetailDescription, writeOption, value, valueSize)
// error : WS_ERROR* -> "pointer"
// faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> "pointer"
// writeOption : WS_WRITE_OPTION -> "i32"
// value : void* optional -> "pointer"
// valueSize : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WsSetFaultErrorDetail(
    intptr_t* error,
    void* faultDetailDescription,
    int32_t writeOption,
    void* value,
    uint32_t valueSize);
C, "webservices.dll");
// $ffi->WsSetFaultErrorDetail(error, faultDetailDescription, writeOption, value, valueSize);
// error : WS_ERROR*
// faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION*
// writeOption : WS_WRITE_OPTION
// value : void* optional
// valueSize : DWORD
// 構造体/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 WsSetFaultErrorDetail(
        LongByReference error,   // WS_ERROR*
        Pointer faultDetailDescription,   // WS_FAULT_DETAIL_DESCRIPTION*
        int writeOption,   // WS_WRITE_OPTION
        Pointer value,   // void* optional
        int valueSize   // DWORD
    );
}
@[Link("webservices")]
lib Libwebservices
  fun WsSetFaultErrorDetail = WsSetFaultErrorDetail(
    error : LibC::SSizeT*,   # WS_ERROR*
    faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION*,   # WS_FAULT_DETAIL_DESCRIPTION*
    writeOption : Int32,   # WS_WRITE_OPTION
    value : Void*,   # void* optional
    valueSize : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WsSetFaultErrorDetailNative = Int32 Function(Pointer<IntPtr>, Pointer<Void>, Int32, Pointer<Void>, Uint32);
typedef WsSetFaultErrorDetailDart = int Function(Pointer<IntPtr>, Pointer<Void>, int, Pointer<Void>, int);
final WsSetFaultErrorDetail = DynamicLibrary.open('webservices.dll')
    .lookupFunction<WsSetFaultErrorDetailNative, WsSetFaultErrorDetailDart>('WsSetFaultErrorDetail');
// error : WS_ERROR* -> Pointer<IntPtr>
// faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> Pointer<Void>
// writeOption : WS_WRITE_OPTION -> Int32
// value : void* optional -> Pointer<Void>
// valueSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WsSetFaultErrorDetail(
  error: Pointer;   // WS_ERROR*
  faultDetailDescription: Pointer;   // WS_FAULT_DETAIL_DESCRIPTION*
  writeOption: Integer;   // WS_WRITE_OPTION
  value: Pointer;   // void* optional
  valueSize: DWORD   // DWORD
): Integer; stdcall;
  external 'webservices.dll' name 'WsSetFaultErrorDetail';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WsSetFaultErrorDetail"
  c_WsSetFaultErrorDetail :: Ptr CIntPtr -> Ptr () -> Int32 -> Ptr () -> Word32 -> IO Int32
-- error : WS_ERROR* -> Ptr CIntPtr
-- faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> Ptr ()
-- writeOption : WS_WRITE_OPTION -> Int32
-- value : void* optional -> Ptr ()
-- valueSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wssetfaulterrordetail =
  foreign "WsSetFaultErrorDetail"
    ((ptr intptr_t) @-> (ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* error : WS_ERROR* -> (ptr intptr_t) *)
(* faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> (ptr void) *)
(* writeOption : WS_WRITE_OPTION -> int32_t *)
(* value : void* optional -> (ptr void) *)
(* valueSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library webservices (t "webservices.dll"))
(cffi:use-foreign-library webservices)

(cffi:defcfun ("WsSetFaultErrorDetail" ws-set-fault-error-detail :convention :stdcall) :int32
  (error :pointer)   ; WS_ERROR*
  (fault-detail-description :pointer)   ; WS_FAULT_DETAIL_DESCRIPTION*
  (write-option :int32)   ; WS_WRITE_OPTION
  (value :pointer)   ; void* optional
  (value-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WsSetFaultErrorDetail = Win32::API::More->new('webservices',
    'int WsSetFaultErrorDetail(LPVOID error, LPVOID faultDetailDescription, int writeOption, LPVOID value, DWORD valueSize)');
# my $ret = $WsSetFaultErrorDetail->Call($error, $faultDetailDescription, $writeOption, $value, $valueSize);
# error : WS_ERROR* -> LPVOID
# faultDetailDescription : WS_FAULT_DETAIL_DESCRIPTION* -> LPVOID
# writeOption : WS_WRITE_OPTION -> int
# value : void* optional -> LPVOID
# valueSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型