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

MsiGetLastErrorRecord

関数
直近に発生したエラー情報を含むレコードハンドルを取得する。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

MSIHANDLE MsiGetLastErrorRecord(void);

パラメーターなし。戻り値: MSIHANDLE

公式ドキュメント

MsiGetLastErrorRecord 関数は、呼び出し元プロセスに対して最後に返されたエラーレコードを返します。この関数が返すハンドルは、MsiCloseHandle を使用して閉じる必要があります。

戻り値

エラーレコードへのハンドル。直前の関数が成功していた場合、 MsiGetLastErrorRecord は null の MSIHANDLE を返します。

解説(Remarks)

MsiGetLastErrorRecord 関数では、レコードのフィールド 1 にインストーラーのエラーコードが格納されます。その他のフィールドには、個々のエラーに固有のデータが格納されます。エラーレコードは、この関数の実行後に内部で解放されます。

レコードを MsiProcessMessage に渡すと、現在のデータベースから文字列を検索して書式設定されます。インストールセッションは存在しないが製品データベースが開かれている場合は、エラーコードを使用して Error テーブルに対してクエリを実行し、続いて MsiFormatRecord を呼び出すことで書式文字列を取得できます。エラーコードが既知であれば、各パラメーターを個別に解釈できます。

以下の関数は、プロセス単位のエラーレコードを設定するか、エラーが発生しなかった場合は null にリセットします。MsiGetLastErrorRecord は、エラーレコードを返した後にそれをクリアします。

MSIHANDLE オブジェクトは MsiCloseHandle を呼び出して閉じる必要があるのに対し、PMSIHANDLE オブジェクトはスコープを外れるとインストーラーによって閉じられるため、PMSIHANDLE 型の変数を使用することが推奨されます。詳細については、Windows Installer のベストプラクティスHANDLE ではなく PMSIHANDLE を使用するのセクションを参照してください。

以下のサンプルでは、MsiDatabaseOpenView の呼び出しを使用して、MsiGetLastErrorRecord をサポートする Windows Installer 関数の 1 つから拡張エラー情報を取得する方法を示します。この例 OpenViewOnDatabase は、データベースハンドルに対してビューを開こうとします。hDatabase ハンドルは、MsiOpenDatabase の呼び出しによって取得できます。ビューを開くのに失敗した場合、この関数は MsiGetLastErrorRecord を使用して拡張エラー情報の取得を試みます。

#include <windows.h>
#include <Msiquery.h>
#pragma comment(lib, "msi.lib")
//-------------------------------------------------------------------
// Function: OpenViewOnDatabase
//
// Arguments: hDatabase - handle to a MSI package obtained
//                                        via a call to MsiOpenDatabase
//
// Returns: UINT status code. ERROR_SUCCESS for success.
//--------------------------------------------------------------------------------------------------
UINT __stdcall OpenViewOnDatabase(MSIHANDLE hDatabase)
{
    if (!hDatabase)
        return ERROR_INVALID_PARAMETER;

    PMSIHANDLE hView = 0;
    UINT uiReturn = MsiDatabaseOpenView(hDatabase, 
                                TEXT("SELECT * FROM `UnknownTable`"),
                           &hView);

    if (ERROR_SUCCESS != uiReturn)
    {
        // try to obtain extended error information.

        PMSIHANDLE hLastErrorRec = MsiGetLastErrorRecord();

        TCHAR* szExtendedError = NULL;
        DWORD cchExtendedError = 0;
        if (hLastErrorRec)
        {
            // Since we are not currently calling MsiFormatRecord during an
            // install session, hInstall is NULL. If MsiFormatRecord was called
            // via a DLL custom action, the hInstall handle provided to the DLL
            // custom action entry point could be used to further resolve 
            // properties that might be contained within the error record.
            
            // To determine the size of the buffer required for the text,
            // szResultBuf must be provided as an empty string with
            // *pcchResultBuf set to 0.

            UINT uiStatus = MsiFormatRecord(NULL,
                             hLastErrorRec,
                             TEXT(""),
                             &cchExtendedError);

            if (ERROR_MORE_DATA == uiStatus)
            {
                // returned size does not include null terminator.
                cchExtendedError++;

                szExtendedError = new TCHAR[cchExtendedError];
                if (szExtendedError)
                {
                    uiStatus = MsiFormatRecord(NULL,
                                     hLastErrorRec,
                                     szExtendedError,
                                     &cchExtendedError);
                    if (ERROR_SUCCESS == uiStatus)
                    {
                        // We now have an extended error
                        // message to report.

                        // PLACE ADDITIONAL CODE HERE
                        // TO LOG THE ERROR MESSAGE
                        // IN szExtendedError.
                    }

                    delete [] szExtendedError;
                    szExtendedError = NULL;
                }
            }
        }
    }

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

各言語での呼び出し定義

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

MSIHANDLE MsiGetLastErrorRecord(void);
[DllImport("msi.dll", ExactSpelling = true)]
static extern uint MsiGetLastErrorRecord();
<DllImport("msi.dll", ExactSpelling:=True)>
Public Shared Function MsiGetLastErrorRecord() As UInteger
End Function
Declare PtrSafe Function MsiGetLastErrorRecord Lib "msi" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiGetLastErrorRecord = ctypes.windll.msi.MsiGetLastErrorRecord
MsiGetLastErrorRecord.restype = wintypes.DWORD
MsiGetLastErrorRecord.argtypes = []
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetLastErrorRecord = Fiddle::Function.new(
  lib['MsiGetLastErrorRecord'],
  [],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiGetLastErrorRecord() -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll")]
public static extern uint MsiGetLastErrorRecord();
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetLastErrorRecord' -Namespace Win32 -PassThru
# $api::MsiGetLastErrorRecord()
#uselib "msi.dll"
#func global MsiGetLastErrorRecord "MsiGetLastErrorRecord"
; MsiGetLastErrorRecord   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiGetLastErrorRecord "MsiGetLastErrorRecord"
; res = MsiGetLastErrorRecord()
; MSIHANDLE MsiGetLastErrorRecord()
#uselib "msi.dll"
#cfunc global MsiGetLastErrorRecord "MsiGetLastErrorRecord"
; res = MsiGetLastErrorRecord()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiGetLastErrorRecord = msi.NewProc("MsiGetLastErrorRecord")
)

r1, _, err := procMsiGetLastErrorRecord.Call()
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // MSIHANDLE
function MsiGetLastErrorRecord: DWORD; stdcall;
  external 'msi.dll' name 'MsiGetLastErrorRecord';
result := DllCall("msi\MsiGetLastErrorRecord", "UInt")
●MsiGetLastErrorRecord() = DLL("msi.dll", "dword MsiGetLastErrorRecord()")
# 呼び出し: MsiGetLastErrorRecord()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef MsiGetLastErrorRecordNative = Uint32 Function();
typedef MsiGetLastErrorRecordDart = int Function();
final MsiGetLastErrorRecord = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiGetLastErrorRecordNative, MsiGetLastErrorRecordDart>('MsiGetLastErrorRecord');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiGetLastErrorRecord: DWORD; stdcall;
  external 'msi.dll' name 'MsiGetLastErrorRecord';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiGetLastErrorRecord"
  c_MsiGetLastErrorRecord :: IO Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msigetlasterrorrecord =
  foreign "MsiGetLastErrorRecord"
    (void @-> returning uint32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiGetLastErrorRecord" msi-get-last-error-record :convention :stdcall) :uint32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiGetLastErrorRecord = Win32::API::More->new('msi',
    'DWORD MsiGetLastErrorRecord()');
# my $ret = $MsiGetLastErrorRecord->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。