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

MsiSetExternalUIW

関数
外部UIメッセージハンドラを登録する(Unicode版)。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

INSTALLUI_HANDLERW MsiSetExternalUIW(
    INSTALLUI_HANDLERW puiHandler,   // optional
    DWORD dwMessageFilter,
    void* pvContext   // optional
);

パラメーター

名前方向説明
puiHandlerINSTALLUI_HANDLERWinoptionalINSTALLUI_HANDLER 仕様に準拠したコールバック関数を指定します。
dwMessageFilterDWORDin

外部メッセージハンドラーを使用して処理するメッセージを指定します。外部ハンドラーが 0 以外の結果を返した場合、そのメッセージは UI には送信されず、代わりにログ記録が有効になっていればメッセージがログに記録されます。詳細については、 MsiEnableLog 関数を参照してください。

意味
INSTALLLOGMODE_FILESINUSE
使用中のファイルに関する情報です。このメッセージを受信した場合は、FilesInUse ダイアログを表示する必要があります。
INSTALLLOGMODE_FATALEXIT
インストールの異常終了です。
INSTALLLOGMODE_ERROR
エラーメッセージがログに記録されます。
INSTALLLOGMODE_WARNING
警告メッセージがログに記録されます。
INSTALLLOGMODE_USER
ユーザー要求がログに記録されます。
INSTALLLOGMODE_INFO
表示されないステータスメッセージがログに記録されます。
INSTALLLOGMODE_RESOLVESOURCE
有効なソースの場所を特定する要求です。
INSTALLLOGMODE_RMFILESINUSE
使用中のファイルに関する情報です。このメッセージを受信した場合は、MsiRMFilesInUse ダイアログを表示する必要があります。
INSTALLLOGMODE_OUTOFDISKSPACE
ディスク領域が不足していました。
INSTALLLOGMODE_ACTIONSTART
新しいインストールアクションの開始がログに記録されます。
INSTALLLOGMODE_ACTIONDATA
インストールアクションを含むデータレコードがログに記録されます。
INSTALLLOGMODE_COMMONDATA
ユーザーインターフェイス初期化のためのパラメーターがログに記録されます。
INSTALLLOGMODE_PROGRESS
プログレスバーの情報です。このメッセージには、これまでの単位数と総単位数に関する情報が含まれます。メッセージ形式の説明については、 MsiProcessMessage 関数を参照してください。このメッセージは外部ユーザーインターフェイスにのみ送信され、ログには記録されません。
INSTALLLOGMODE_INITIALIZE
これがサイレントインストールでない場合、基本 UI が初期化されています。完全 UI のインストールの場合、完全 UI はまだ初期化されていません。このメッセージは外部ユーザーインターフェイスにのみ送信され、ログには記録されません。
INSTALLLOGMODE_TERMINATE
完全 UI が使用されている場合、完全 UI は終了しています。これがサイレントインストールでない場合、基本 UI はまだ終了していません。このメッセージは外部ユーザーインターフェイスにのみ送信され、ログには記録されません。
INSTALLLOGMODE_SHOWDIALOG
完全 UI ダイアログの表示前に送信されます。このメッセージは外部ユーザーインターフェイスにのみ送信され、ログには記録されません。
INSTALLLOGMODE_INSTALLSTART
製品のインストールが開始されます。

このメッセージには、製品の ProductName と ProductCode が含まれます。

INSTALLLOGMODE_INSTALLEND
製品のインストールが終了します。

このメッセージには、製品の ProductName、ProductCode、および戻り値が含まれます。

pvContextvoid*inoptionalコールバック関数に渡されるアプリケーションコンテキストへのポインターです。このパラメーターはエラーチェックに使用できます。

戻り値の型: INSTALLUI_HANDLERW

公式ドキュメント

MsiSetExternalUI 関数は、外部ユーザーインターフェイスハンドラーを有効にします。(Unicode)

戻り値

戻り値は、以前に設定されていた外部ハンドラーです。以前に設定されたハンドラーが存在しなかった場合は 0 です。

解説(Remarks)

以前の UI ハンドラーを復元するには、最初の MsiSetExternalUI 呼び出しで返された INSTALLUI_HANDLER を使用し、dwMessageFilter に 0 を指定して MsiSetExternalUI を 2 回目に呼び出します。

puiHandler パラメーターが指す外部ユーザーインターフェイスハンドラーは、dwUILevel パラメーターに INSTALLUILEVEL_NONE を設定して MsiSetInternalUI を呼び出さない限り、外部ユーザーインターフェイスを完全には制御できません。 MsiSetInternalUI が呼び出されない場合、内部ユーザーインターフェイスレベルは既定で INSTALLUILEVEL_BASIC になります。その結果、外部ユーザーインターフェイスハンドラーで処理されないメッセージは、Windows Installer によって処理されます。最初の「インストールの準備をしています...」ダイアログは、外部ユーザーインターフェイスハンドラーがすべてのメッセージを処理する場合でも常に表示されます。

MsiSetExternalUI は、 ブートストラップアプリケーションからのみ呼び出す必要があります。カスタムアクションから MsiSetExternalUI を呼び出すことはできません。

メモ

msi.h ヘッダーは、MsiSetExternalUI を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

INSTALLUI_HANDLERW MsiSetExternalUIW(
    INSTALLUI_HANDLERW puiHandler,   // optional
    DWORD dwMessageFilter,
    void* pvContext   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr MsiSetExternalUIW(
    IntPtr puiHandler,   // INSTALLUI_HANDLERW optional
    uint dwMessageFilter,   // DWORD
    IntPtr pvContext   // void* optional
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiSetExternalUIW(
    puiHandler As IntPtr,   ' INSTALLUI_HANDLERW optional
    dwMessageFilter As UInteger,   ' DWORD
    pvContext As IntPtr   ' void* optional
) As IntPtr
End Function
' puiHandler : INSTALLUI_HANDLERW optional
' dwMessageFilter : DWORD
' pvContext : void* optional
Declare PtrSafe Function MsiSetExternalUIW Lib "msi" ( _
    ByVal puiHandler As LongPtr, _
    ByVal dwMessageFilter As Long, _
    ByVal pvContext As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiSetExternalUIW = ctypes.windll.msi.MsiSetExternalUIW
MsiSetExternalUIW.restype = ctypes.c_void_p
MsiSetExternalUIW.argtypes = [
    ctypes.c_void_p,  # puiHandler : INSTALLUI_HANDLERW optional
    wintypes.DWORD,  # dwMessageFilter : DWORD
    ctypes.POINTER(None),  # pvContext : void* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiSetExternalUIW = Fiddle::Function.new(
  lib['MsiSetExternalUIW'],
  [
    Fiddle::TYPE_VOIDP,  # puiHandler : INSTALLUI_HANDLERW optional
    -Fiddle::TYPE_INT,  # dwMessageFilter : DWORD
    Fiddle::TYPE_VOIDP,  # pvContext : void* optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiSetExternalUIW(
        puiHandler: *const core::ffi::c_void,  // INSTALLUI_HANDLERW optional
        dwMessageFilter: u32,  // DWORD
        pvContext: *mut ()  // void* optional
    ) -> *const core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr MsiSetExternalUIW(IntPtr puiHandler, uint dwMessageFilter, IntPtr pvContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSetExternalUIW' -Namespace Win32 -PassThru
# $api::MsiSetExternalUIW(puiHandler, dwMessageFilter, pvContext)
#uselib "msi.dll"
#func global MsiSetExternalUIW "MsiSetExternalUIW" wptr, wptr, wptr
; MsiSetExternalUIW puiHandler, dwMessageFilter, pvContext   ; 戻り値は stat
; puiHandler : INSTALLUI_HANDLERW optional -> "wptr"
; dwMessageFilter : DWORD -> "wptr"
; pvContext : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiSetExternalUIW "MsiSetExternalUIW" sptr, int, sptr
; res = MsiSetExternalUIW(puiHandler, dwMessageFilter, pvContext)
; puiHandler : INSTALLUI_HANDLERW optional -> "sptr"
; dwMessageFilter : DWORD -> "int"
; pvContext : void* optional -> "sptr"
; INSTALLUI_HANDLERW MsiSetExternalUIW(INSTALLUI_HANDLERW puiHandler, DWORD dwMessageFilter, void* pvContext)
#uselib "msi.dll"
#cfunc global MsiSetExternalUIW "MsiSetExternalUIW" intptr, int, intptr
; res = MsiSetExternalUIW(puiHandler, dwMessageFilter, pvContext)
; puiHandler : INSTALLUI_HANDLERW optional -> "intptr"
; dwMessageFilter : DWORD -> "int"
; pvContext : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiSetExternalUIW = msi.NewProc("MsiSetExternalUIW")
)

// puiHandler (INSTALLUI_HANDLERW optional), dwMessageFilter (DWORD), pvContext (void* optional)
r1, _, err := procMsiSetExternalUIW.Call(
	uintptr(puiHandler),
	uintptr(dwMessageFilter),
	uintptr(pvContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INSTALLUI_HANDLERW
function MsiSetExternalUIW(
  puiHandler: Pointer;   // INSTALLUI_HANDLERW optional
  dwMessageFilter: DWORD;   // DWORD
  pvContext: Pointer   // void* optional
): Pointer; stdcall;
  external 'msi.dll' name 'MsiSetExternalUIW';
result := DllCall("msi\MsiSetExternalUIW"
    , "Ptr", puiHandler   ; INSTALLUI_HANDLERW optional
    , "UInt", dwMessageFilter   ; DWORD
    , "Ptr", pvContext   ; void* optional
    , "Ptr")   ; return: INSTALLUI_HANDLERW
●MsiSetExternalUIW(puiHandler, dwMessageFilter, pvContext) = DLL("msi.dll", "void* MsiSetExternalUIW(void*, dword, void*)")
# 呼び出し: MsiSetExternalUIW(puiHandler, dwMessageFilter, pvContext)
# puiHandler : INSTALLUI_HANDLERW optional -> "void*"
# dwMessageFilter : DWORD -> "dword"
# pvContext : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiSetExternalUIW(
    puiHandler: ?*anyopaque, // INSTALLUI_HANDLERW optional
    dwMessageFilter: u32, // DWORD
    pvContext: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiSetExternalUIW(
    puiHandler: pointer,  # INSTALLUI_HANDLERW optional
    dwMessageFilter: uint32,  # DWORD
    pvContext: pointer  # void* optional
): pointer {.importc: "MsiSetExternalUIW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
void* MsiSetExternalUIW(
    void* puiHandler,   // INSTALLUI_HANDLERW optional
    uint dwMessageFilter,   // DWORD
    void* pvContext   // void* optional
);
ccall((:MsiSetExternalUIW, "msi.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
      puiHandler, dwMessageFilter, pvContext)
# puiHandler : INSTALLUI_HANDLERW optional -> Ptr{Cvoid}
# dwMessageFilter : DWORD -> UInt32
# pvContext : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* MsiSetExternalUIW(
    void* puiHandler,
    uint32_t dwMessageFilter,
    void* pvContext);
]]
local msi = ffi.load("msi")
-- msi.MsiSetExternalUIW(puiHandler, dwMessageFilter, pvContext)
-- puiHandler : INSTALLUI_HANDLERW optional
-- dwMessageFilter : DWORD
-- pvContext : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiSetExternalUIW = lib.func('__stdcall', 'MsiSetExternalUIW', 'void *', ['void *', 'uint32_t', 'void *']);
// MsiSetExternalUIW(puiHandler, dwMessageFilter, pvContext)
// puiHandler : INSTALLUI_HANDLERW optional -> 'void *'
// dwMessageFilter : DWORD -> 'uint32_t'
// pvContext : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("msi.dll", {
  MsiSetExternalUIW: { parameters: ["pointer", "u32", "pointer"], result: "pointer" },
});
// lib.symbols.MsiSetExternalUIW(puiHandler, dwMessageFilter, pvContext)
// puiHandler : INSTALLUI_HANDLERW optional -> "pointer"
// dwMessageFilter : DWORD -> "u32"
// pvContext : void* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* MsiSetExternalUIW(
    void* puiHandler,
    uint32_t dwMessageFilter,
    void* pvContext);
C, "msi.dll");
// $ffi->MsiSetExternalUIW(puiHandler, dwMessageFilter, pvContext);
// puiHandler : INSTALLUI_HANDLERW optional
// dwMessageFilter : DWORD
// pvContext : void* 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 Msi extends StdCallLibrary {
    Msi INSTANCE = Native.load("msi", Msi.class, W32APIOptions.UNICODE_OPTIONS);
    Pointer MsiSetExternalUIW(
        Callback puiHandler,   // INSTALLUI_HANDLERW optional
        int dwMessageFilter,   // DWORD
        Pointer pvContext   // void* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiSetExternalUIW = MsiSetExternalUIW(
    puiHandler : Void*,   # INSTALLUI_HANDLERW optional
    dwMessageFilter : UInt32,   # DWORD
    pvContext : Void*   # void* optional
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiSetExternalUIWNative = Pointer<Void> Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef MsiSetExternalUIWDart = Pointer<Void> Function(Pointer<Void>, int, Pointer<Void>);
final MsiSetExternalUIW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiSetExternalUIWNative, MsiSetExternalUIWDart>('MsiSetExternalUIW');
// puiHandler : INSTALLUI_HANDLERW optional -> Pointer<Void>
// dwMessageFilter : DWORD -> Uint32
// pvContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiSetExternalUIW(
  puiHandler: Pointer;   // INSTALLUI_HANDLERW optional
  dwMessageFilter: DWORD;   // DWORD
  pvContext: Pointer   // void* optional
): Pointer; stdcall;
  external 'msi.dll' name 'MsiSetExternalUIW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiSetExternalUIW"
  c_MsiSetExternalUIW :: Ptr () -> Word32 -> Ptr () -> IO (Ptr ())
-- puiHandler : INSTALLUI_HANDLERW optional -> Ptr ()
-- dwMessageFilter : DWORD -> Word32
-- pvContext : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("MsiSetExternalUIW" msi-set-external-uiw :convention :stdcall) :pointer
  (pui-handler :pointer)   ; INSTALLUI_HANDLERW optional
  (dw-message-filter :uint32)   ; DWORD
  (pv-context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiSetExternalUIW = Win32::API::More->new('msi',
    'LPVOID MsiSetExternalUIW(LPVOID puiHandler, DWORD dwMessageFilter, LPVOID pvContext)');
# my $ret = $MsiSetExternalUIW->Call($puiHandler, $dwMessageFilter, $pvContext);
# puiHandler : INSTALLUI_HANDLERW optional -> LPVOID
# dwMessageFilter : DWORD -> DWORD
# pvContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型