Win32 API 日本語リファレンス
ホームSystem.Com › SetErrorInfo

SetErrorInfo

関数
現在の論理スレッドにエラー情報オブジェクトを設定する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT SetErrorInfo(
    DWORD dwReserved,
    IErrorInfo* perrinfo   // optional
);

パラメーター

名前方向説明
dwReservedDWORDin将来の使用のために予約されています。ゼロを指定する必要があります。
perrinfoIErrorInfo*inoptionalエラーオブジェクトです。

戻り値の型: HRESULT

公式ドキュメント

現在の論理スレッドの実行に対するエラー情報オブジェクトを設定します。

戻り値

この関数が成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

この関数は、既存のエラー情報オブジェクトが存在する場合はそれを解放し、ポインターを perrinfo に設定します。エラーオブジェクトを作成した後にこの関数を使用して、そのオブジェクトを現在の論理スレッドの実行に関連付けます。

SetErrorInfo を呼び出すプロパティまたはメソッドが DispInvoke によって呼び出された場合、DispInvoke はエラー情報オブジェクトで指定された値で EXCEPINFO パラメーターを埋めます。プロパティまたはメソッドが DispInvoke に対して失敗を示す戻り値を返すと、DispInvokeDISP_E_EXCEPTION を返します。

IDispatch::Invoke を使用しない仮想関数テーブル (VTBL) バインディングコントローラーは、GetErrorInfo を使用してエラー情報オブジェクトを取得できます。これにより、デュアルインターフェイスをサポートするオブジェクトは、クライアントが VTBL バインディングと IDispatch のどちらを使用するかに関係なく SetErrorInfo を使用できます。

アパートメントをまたぐ呼び出しが行われると、COM はすべてのエラーオブジェクトをクリアします。

プロキシ/スタブを経由する COM 呼び出しを行うと、呼び出し元スレッドの既存のエラーオブジェクトがすべてクリアされます。呼び出されたオブジェクトは、SetErrorInfo を呼び出した後、戻る前にそのような呼び出しを行ってはなりません。呼び出し元は、呼び出しから戻った後、GetErrorInfo を呼び出す前にそのような呼び出しを行ってはなりません。経験則として、インターフェイスメソッドは SetErrorInfo を呼び出した後できるだけ早く戻り、呼び出し元は呼び出しから戻った後できるだけ早く GetErrorInfo を呼び出すべきです。

COM のモーダルメッセージループに入ると、既存のエラーオブジェクトがすべてクリアされます。呼び出されたオブジェクトは、SetErrorInfo を呼び出した後にメッセージループに入ってはなりません。

ICreateErrorInfo *pcerrinfo;
IErrorInfo *perrinfo;
HRESULT hr;

hr = CreateErrorInfo(&pcerrinfo);
if (SUCCEEDED(hr))
{
   hr = pcerrinfo->QueryInterface(IID_IErrorInfo, (LPVOID FAR*) &perrinfo);
   if (SUCCEEDED(hr))
   {
      SetErrorInfo(0, perrinfo);
      perrinfo->Release();
   }
   pcerrinfo->Release();
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT SetErrorInfo(
    DWORD dwReserved,
    IErrorInfo* perrinfo   // optional
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int SetErrorInfo(
    uint dwReserved,   // DWORD
    IntPtr perrinfo   // IErrorInfo* optional
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function SetErrorInfo(
    dwReserved As UInteger,   ' DWORD
    perrinfo As IntPtr   ' IErrorInfo* optional
) As Integer
End Function
' dwReserved : DWORD
' perrinfo : IErrorInfo* optional
Declare PtrSafe Function SetErrorInfo Lib "oleaut32" ( _
    ByVal dwReserved As Long, _
    ByVal perrinfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetErrorInfo = ctypes.windll.oleaut32.SetErrorInfo
SetErrorInfo.restype = ctypes.c_int
SetErrorInfo.argtypes = [
    wintypes.DWORD,  # dwReserved : DWORD
    ctypes.c_void_p,  # perrinfo : IErrorInfo* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
SetErrorInfo = Fiddle::Function.new(
  lib['SetErrorInfo'],
  [
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
    Fiddle::TYPE_VOIDP,  # perrinfo : IErrorInfo* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "oleaut32")]
extern "system" {
    fn SetErrorInfo(
        dwReserved: u32,  // DWORD
        perrinfo: *mut core::ffi::c_void  // IErrorInfo* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int SetErrorInfo(uint dwReserved, IntPtr perrinfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_SetErrorInfo' -Namespace Win32 -PassThru
# $api::SetErrorInfo(dwReserved, perrinfo)
#uselib "OLEAUT32.dll"
#func global SetErrorInfo "SetErrorInfo" sptr, sptr
; SetErrorInfo dwReserved, perrinfo   ; 戻り値は stat
; dwReserved : DWORD -> "sptr"
; perrinfo : IErrorInfo* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLEAUT32.dll"
#cfunc global SetErrorInfo "SetErrorInfo" int, sptr
; res = SetErrorInfo(dwReserved, perrinfo)
; dwReserved : DWORD -> "int"
; perrinfo : IErrorInfo* optional -> "sptr"
; HRESULT SetErrorInfo(DWORD dwReserved, IErrorInfo* perrinfo)
#uselib "OLEAUT32.dll"
#cfunc global SetErrorInfo "SetErrorInfo" int, intptr
; res = SetErrorInfo(dwReserved, perrinfo)
; dwReserved : DWORD -> "int"
; perrinfo : IErrorInfo* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procSetErrorInfo = oleaut32.NewProc("SetErrorInfo")
)

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

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

typedef SetErrorInfoNative = Int32 Function(Uint32, Pointer<Void>);
typedef SetErrorInfoDart = int Function(int, Pointer<Void>);
final SetErrorInfo = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<SetErrorInfoNative, SetErrorInfoDart>('SetErrorInfo');
// dwReserved : DWORD -> Uint32
// perrinfo : IErrorInfo* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetErrorInfo(
  dwReserved: DWORD;   // DWORD
  perrinfo: Pointer   // IErrorInfo* optional
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'SetErrorInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetErrorInfo"
  c_SetErrorInfo :: Word32 -> Ptr () -> IO Int32
-- dwReserved : DWORD -> Word32
-- perrinfo : IErrorInfo* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let seterrorinfo =
  foreign "SetErrorInfo"
    (uint32_t @-> (ptr void) @-> returning int32_t)
(* dwReserved : DWORD -> uint32_t *)
(* perrinfo : IErrorInfo* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("SetErrorInfo" set-error-info :convention :stdcall) :int32
  (dw-reserved :uint32)   ; DWORD
  (perrinfo :pointer))   ; IErrorInfo* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetErrorInfo = Win32::API::More->new('OLEAUT32',
    'int SetErrorInfo(DWORD dwReserved, LPVOID perrinfo)');
# my $ret = $SetErrorInfo->Call($dwReserved, $perrinfo);
# dwReserved : DWORD -> DWORD
# perrinfo : IErrorInfo* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型