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

GetErrorInfo

関数
現在の論理スレッドに設定されたエラー情報を取得する。
DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT GetErrorInfo(
    DWORD dwReserved,
    IErrorInfo** pperrinfo
);

パラメーター

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

戻り値の型: HRESULT

公式ドキュメント

現在の論理スレッドにおいて、直前の SetErrorInfo の呼び出しで設定されたエラー情報ポインターを取得します。

戻り値

この関数は次のいずれかの値を返します。

戻り値 説明
S_OK
成功しました。
S_FALSE
返すべきエラーオブジェクトがありませんでした。

解説(Remarks)

この関数は、現在の論理スレッドで最後に設定された IErrorInfo ポインターへのポインターを返します。エラーオブジェクトの所有権を呼び出し元に移転し、スレッドのエラー状態をクリアします。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

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

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procGetErrorInfo = oleaut32.NewProc("GetErrorInfo")
)

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

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

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

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

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

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

関連項目

使用する型