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

INSTALLUI_HANDLERW

コールバック

シグネチャ

INT INSTALLUI_HANDLERW(
    void* pvContext,
    DWORD iMessageType,
    LPWSTR szMessage
);

パラメーター

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

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

メッセージボックスのスタイル (Message box StylesFlag) 意味
MB_ABORTRETRYIGNORE
メッセージボックスに 中止、再試行、無視 の各ボタンが表示されます。
MB_OK
メッセージボックスに OK ボタンが表示されます。これが既定です。
MB_OKCANCEL
メッセージボックスに OK と キャンセル のボタンが表示されます。
MB_RETRYCANCEL
メッセージボックスに 再試行 と キャンセル のボタンが表示されます。
MB_YESNO
メッセージボックスに はい と いいえ のボタンが表示されます。
MB_YESNOCANCEL
メッセージボックスに はい、いいえ、キャンセル の各ボタンが表示されます。
メッセージボックスのアイコンの種類 (Message box IconTypesFlag) 意味
MB_ICONEXCLAMATION, MB_ICONWARNING
メッセージボックスに感嘆符が表示されます。
MB_ICONINFORMATION, MB_ICONASTERISK
メッセージボックスに情報アイコンが表示されます。
MB_ICONQUESTION
メッセージボックスに疑問符が表示されます。
MB_ICONSTOP, MB_ICONERROR, MB_ICONHAND
メッセージボックスに停止アイコンが表示されます。
既定のボタン (Default ButtonsFlag) 意味
MB_DEFBUTTON1
1 番目のボタンが既定のボタンになります。
MB_DEFBUTTON2
2 番目のボタンが既定のボタンになります。
MB_DEFBUTTON3
3 番目のボタンが既定のボタンになります。
インストールメッセージの種類 (Install message TypesFlag) 意味
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。インストールメッセージの種類に既定値はなく、メッセージの種類は常に指定されます。

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

公式ドキュメント

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)