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

MsiProcessMessage

関数
インストール中の進行状況やエラーのメッセージを送信し処理する。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

INT MsiProcessMessage(
    MSIHANDLE hInstall,
    INSTALLMESSAGE eMessageType,
    MSIHANDLE hRecord
);

パラメーター

名前方向説明
hInstallMSIHANDLEinDLL カスタムアクションに提供された、または MsiOpenPackageMsiOpenPackageExMsiOpenProduct によって取得したインストールへのハンドル。
eMessageTypeINSTALLMESSAGEin

eMessage パラメーターには、次のいずれかのメッセージタイプを指定する値を指定する必要があります。プッシュボタンまたはアイコンを含むメッセージボックスを表示するには、OR 演算子を使用して、INSTALLMESSAGE_ERRORINSTALLMESSAGE_WARNING、または INSTALLMESSAGE_USER を、 MessageBox および MessageBoxEx 関数で使用される標準のメッセージボックススタイルに追加します。詳細については、後述の「解説」を参照してください。

意味
INSTALLMESSAGE_FATALEXIT
早期終了。致命的なメモリ不足の可能性があります。
INSTALLMESSAGE_ERROR
書式設定されたエラーメッセージ。
[1] は Error テーブル内のメッセージ番号です。
INSTALLMESSAGE_WARNING
書式設定された警告メッセージ。
[1] は Error テーブル内のメッセージ番号です。
INSTALLMESSAGE_USER
ユーザー要求メッセージ。
[1] は Error テーブル内のメッセージ番号です。
INSTALLMESSAGE_INFO
ログ用の情報メッセージ。
表示されません。
INSTALLMESSAGE_FILESINUSE
置き換える前に閉じる必要がある、現在使用中のファイルの一覧。
INSTALLMESSAGE_RESOLVESOURCE
有効なソースの場所を特定するための要求。
INSTALLMESSAGE_RMFILESINUSE
置き換える前に閉じる必要がある、現在使用中のファイルの一覧。Windows Installer バージョン 4.0 以降で利用できます。このメッセージの詳細については、Using Restart Manager with an External UI を参照してください。
INSTALLMESSAGE_OUTOFDISKSPACE
ディスク容量不足メッセージ。
INSTALLMESSAGE_ACTIONSTART
進行状況: アクションの開始。
[1] アクション名、
[2] 説明、
[3] ACTIONDATA メッセージ用のテンプレート。
INSTALLMESSAGE_ACTIONDATA
アクションデータ。レコードフィールドは ACTIONSTART メッセージのテンプレートに対応します。
INSTALLMESSAGE_PROGRESS
進行状況バーの情報。後述のレコードフィールドの説明を参照してください。
INSTALLMESSAGE_COMMONDATA
[キャンセル] ボタンを有効にするには、[1] を 2 に、[2] を 1 に設定します。

[キャンセル] ボタンを無効にするには、[1] を 2 に、[2] を 0 に設定します。

hRecordMSIHANDLEinメッセージの書式とデータを含むレコードへのハンドル。

戻り値の型: INT

公式ドキュメント

MsiProcessMessage 関数は、処理のためにエラーレコードをインストーラーに送信します。

戻り値

この関数は int を返します。

解説(Remarks)

MsiProcessMessage 関数は、有効になっているログ記録操作を実行し、実行を延期します。さまざまなメッセージタイプに対して、ログ記録を選択的に有効にできます。

INSTALLMESSAGE_FATALEXITINSTALLMESSAGE_ERRORINSTALLMESSAGE_WARNING、および INSTALLMESSAGE_USER メッセージの場合、フィールド 0 が設定されていないときは、フィールド 1 に Error テーブル内のエラーメッセージに対応するエラーコードを設定する必要があります。その後、メッセージは Error テーブルのテンプレートを使用して書式設定されてから、表示のためにユーザーインターフェイスハンドラーに渡されます。

進行状況バーメッセージのレコードフィールド

eMessageType が INSTALLMESSAGE_PROGRESS に設定されている場合のレコードフィールドについて説明します。フィールド 1 は進行状況メッセージのタイプを指定します。他のフィールドの意味は、このフィールドの値によって異なります。フィールド 1 に設定できる値は次のとおりです。
フィールド 1 の値 フィールド 1 の説明
0 進行状況バーをリセットし、バー内で予想されるティックの総数を設定します。
1 現在のアクションによって送信される進行状況メッセージに関連する情報を提供します。
2 進行状況バーを進めます。
3 アクション (CustomAction など) が、進行状況バーの予想される進行状況の総数にティックを追加できるようにします。

フィールド 2 の意味は、フィールド 1 の値によって次のように異なります。

フィールド 1 の値 フィールド 2 の説明
0 進行状況バー内で予想されるティックの総数。
1 現在のアクションによって送信される ActionData メッセージごとに進行状況バーが進むティック数。フィールド 3 が 0 の場合、このフィールドは無視されます。
2 進行状況バーが進んだティック数。
3 予想される進行状況の合計に追加するティック数。

フィールド 3 の意味は、フィールド 1 の値によって次のように異なります。

フィールド 1 の値 フィールド 3 の値 フィールド 3 の説明
0 0 順方向の進行状況バー (左から右)
1 逆方向の進行状況バー (右から左)
1 0 現在のアクションは明示的な ProgressReport メッセージを送信します。
1 現在のアクションによって ActionData メッセージが送信されるたびに、フィールド 2 で指定されたティック数だけ進行状況バーを進めます。
2 未使用
3 未使用

フィールド 4 の意味は、フィールド 1 の値によって次のように異なります。

フィールド 1 の値 フィールド 4 の値 フィールド 4 の説明
0 0 実行が進行中です。この場合、UI は残り時間を計算して表示できます。
1 実行スクリプトを作成中です。この場合、UI はインストーラーがインストールの準備を完了するまで待つようにメッセージを表示できます。
1 未使用
2 未使用
3 未使用

詳細とコードサンプルについては、 Adding Custom Actions to the ProgressBar を参照してください。

メッセージボックスの表示

プッシュボタンまたはアイコンを含むメッセージボックスを表示するには、OR 演算子を使用して、INSTALLMESSAGE_ERRORINSTALLMESSAGE_WARNING、または INSTALLMESSAGE_USER を、MessageBox および MessageBoxEx で使用されるメッセージボックスオプションに追加します。使用できるプッシュボタンオプションは、MB_OKMB_OKCANCELMB_ABORTRETRYIGNOREMB_YESNOCANCELMB_YESNO、および MB_RETRYCANCEL です。使用できる既定のボタンオプションは、MB_DEFBUTTON1MB_DEFBUTTON2、および MB_DEFBUTTON3 です。使用できるアイコンオプションは、MB_ICONERRORMB_ICONQUESTIONMB_ICONWARNING、および MB_ICONINFORMATION です。アイコンオプションが指定されていない場合、Windows Installer はメッセージタイプに基づいて既定のアイコンスタイルを選択します。

たとえば、次の MsiProcessMessage の呼び出しは、MB_ICONWARNING アイコンと MB_ABORTRETRYCANCEL ボタンを含む INSTALLMESSAGE_ERROR メッセージを送信します。

PMSIHANDLE hInstall;
PMSIHANDLE hRec;
MsiProcessMessage(hInstall, 
                  INSTALLMESSAGE(INSTALLMESSAGE_ERROR|MB_ABORTRETRYIGNORE|MB_ICONWARNING),
                  hRec);

カスタムアクションが MsiProcessMessage を呼び出す場合、そのカスタムアクションはユーザーによるキャンセルを処理できる必要があり、ERROR_INSTALL_USEREXIT を返す必要があります。

MsiProcessMessage によるメッセージの送信の詳細については、 Sending Messages to Windows Installer Using MsiProcessMessage を参照してください。

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

各言語での呼び出し定義

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

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

MsiProcessMessage = ctypes.windll.msi.MsiProcessMessage
MsiProcessMessage.restype = ctypes.c_int
MsiProcessMessage.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    ctypes.c_int,  # eMessageType : INSTALLMESSAGE
    wintypes.DWORD,  # hRecord : MSIHANDLE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiProcessMessage = msi.NewProc("MsiProcessMessage")
)

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

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

typedef MsiProcessMessageNative = Int32 Function(Uint32, Int32, Uint32);
typedef MsiProcessMessageDart = int Function(int, int, int);
final MsiProcessMessage = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiProcessMessageNative, MsiProcessMessageDart>('MsiProcessMessage');
// hInstall : MSIHANDLE -> Uint32
// eMessageType : INSTALLMESSAGE -> Int32
// hRecord : MSIHANDLE -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiProcessMessage(
  hInstall: DWORD;   // MSIHANDLE
  eMessageType: Integer;   // INSTALLMESSAGE
  hRecord: DWORD   // MSIHANDLE
): Integer; stdcall;
  external 'msi.dll' name 'MsiProcessMessage';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiProcessMessage"
  c_MsiProcessMessage :: Word32 -> Int32 -> Word32 -> IO Int32
-- hInstall : MSIHANDLE -> Word32
-- eMessageType : INSTALLMESSAGE -> Int32
-- hRecord : MSIHANDLE -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiprocessmessage =
  foreign "MsiProcessMessage"
    (uint32_t @-> int32_t @-> uint32_t @-> returning int32_t)
(* hInstall : MSIHANDLE -> uint32_t *)
(* eMessageType : INSTALLMESSAGE -> int32_t *)
(* hRecord : MSIHANDLE -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiProcessMessage" msi-process-message :convention :stdcall) :int32
  (h-install :uint32)   ; MSIHANDLE
  (e-message-type :int32)   ; INSTALLMESSAGE
  (h-record :uint32))   ; MSIHANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiProcessMessage = Win32::API::More->new('msi',
    'int MsiProcessMessage(DWORD hInstall, int eMessageType, DWORD hRecord)');
# my $ret = $MsiProcessMessage->Call($hInstall, $eMessageType, $hRecord);
# hInstall : MSIHANDLE -> DWORD
# eMessageType : INSTALLMESSAGE -> int
# hRecord : MSIHANDLE -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型