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

INSTALLUI_HANDLERA

コールバック

シグネチャ

INT INSTALLUI_HANDLERA(
    void* pvContext,
    DWORD iMessageType,
    LPSTR szMessage
);

パラメーター

フィールド型説明
pvContextvoid*MsiSetExternalUI 関数に渡されたアプリケーションコンテキストへのポインター。このパラメーターはエラーチェックに使用できます。
iMessageTypeDWORD

1 つのメッセージボックススタイル、1 つのメッセージボックスアイコンの種類、1 つの既定のボタン、および 1 つのインストールメッセージの種類の組み合わせを指定します。このパラメーターは、次のいずれかである必要があります。

メッセージボックスのスタイル (Flag) 意味
MB_ABORTRETRYIGNORE
メッセージボックスには 中止、再試行、無視 の各ボタンが含まれます。
MB_OK
メッセージボックスには OK ボタンが含まれます。これが既定値です。
MB_OKCANCEL
メッセージボックスには OK と キャンセル の各ボタンが含まれます。
MB_RETRYCANCEL
メッセージボックスには 再試行 と キャンセル の各ボタンが含まれます。
MB_YESNO
メッセージボックスには はい と いいえ の各ボタンが含まれます。
MB_YESNOCANCEL
メッセージボックスには はい、いいえ、キャンセル の各ボタンが含まれます。
メッセージボックスのアイコンの種類 (Flag) 意味
MB_ICONEXCLAMATION, MB_ICONWARNING
メッセージボックスに感嘆符が表示されます。
MB_ICONINFORMATION, MB_ICONASTERISK
メッセージボックスに情報アイコンが表示されます。
MB_ICONQUESTION
メッセージボックスに疑問符が表示されます。
MB_ICONSTOP, MB_ICONERROR, MB_ICONHAND
メッセージボックスに停止アイコンが表示されます。
既定のボタン (Flag) 意味
MB_DEFBUTTON1
1 番目のボタンが既定のボタンになります。
MB_DEFBUTTON2
2 番目のボタンが既定のボタンになります。
MB_DEFBUTTON3
3 番目のボタンが既定のボタンになります。
インストールメッセージの種類 (Flag) 意味
INSTALLMESSAGE_FATALEXIT
異常終了
INSTALLMESSAGE_ERROR
書式設定されたエラーメッセージ
INSTALLMESSAGE_WARNING
書式設定された警告メッセージ
INSTALLMESSAGE_USER
ユーザー要求メッセージ。
INSTALLMESSAGE_INFO
ログ用の情報メッセージ
INSTALLMESSAGE_FILESINUSE
置き換える前に閉じる必要がある、現在使用中のファイルの一覧。
INSTALLMESSAGE_RESOLVESOURCE
有効なソースの場所を特定するための要求
INSTALLMESSAGE_RMFILESINUSE
置き換える前に閉じる必要がある、現在使用中のファイルの一覧。Windows Installer 4.0 以降で使用できます。このメッセージの詳細については、Using Restart Manager with an External UI を参照してください。
INSTALLMESSAGE_OUTOFDISKSPACE
ディスク領域不足のメッセージ
INSTALLMESSAGE_ACTIONSTART
アクションの開始メッセージ。このメッセージにはアクション名と説明が含まれます。
INSTALLMESSAGE_ACTIONDATA
個々のアクション項目に関連付けられた、書式設定されたデータ。
INSTALLMESSAGE_PROGRESS
進行状況ゲージの情報。このメッセージには、これまでに処理した単位数と単位の総数の情報が含まれます。
INSTALLMESSAGE_COMMONDATA
ユーザーインターフェイス用の書式設定されたダイアログ情報。
INSTALLMESSAGE_INITIALIZE
UI の初期化前に送信されます。文字列データはありません
INSTALLMESSAGE_TERMINATE
UI の終了後に送信されます。文字列データはありません
INSTALLMESSAGE_SHOWDIALOG
作成済みのダイアログまたはウィザードを表示する前に送信されます
INSTALLMESSAGE_INSTALLSTART
製品のインストール前に送信されます。
INSTALLMESSAGE_INSTALLEND
製品のインストール後に送信されます。

上記のメッセージのいずれかが指定されていない場合は、次の既定値が使用されます: MB_OK、アイコンなし、MB_DEFBUTTON1。インストールメッセージの種類に既定値はありません。メッセージの種類は常に指定されます。

szMessageLPSTRメッセージのテキストを指定します。

公式ドキュメント

INSTALLUI_HANDLER 関数プロトタイプは、進行状況の通知とエラーメッセージのためにインストーラーが呼び出すコールバック関数を定義します。この関数プロトタイプの使用方法の詳細およびサンプルコードについては、 Handling Progress Messages Using MsiSetExternalUI を参照してください。

戻り値

次の戻り値は、メッセージボックススタイルで指定されたボタンに対応します:

IDOK

IDCANCEL
IDABORT
IDRETRY
IDIGNORE
IDYES
IDNO

解説(Remarks)

外部ユーザーインターフェイスハンドラーから値を返す方法の詳細については、 Returning Values from an External User Interface Handler のトピックを参照してください。

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、INSTALLUI_HANDLER を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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