INSTALLUI_HANDLERA コールバック関数 (msi.h)

  • [アーティクル]

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

構文

INSTALLUI_HANDLERA InstalluiHandlera;

int InstalluiHandlera(
  LPVOID pvContext,
  UINT iMessageType,
  LPCSTR szMessage
)
{...}

パラメーター

pvContext

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

iMessageType

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

メッセージ ボックスのスタイルフラグ 意味
MB_ABORTRETRYIGNORE
 メッセージ ボックスには、[ 中止]、[ 再試行]、[ 無視 ] の各ボタンが表示されます。
MB_OK
 メッセージ ボックスに [OK] ボタンが表示されます。 既定値です。
MB_OKCANCEL
 メッセージ ボックスには、[ OK] ボタンと [キャンセル] ボタンが含まれています。
MB_RETRYCANCEL
 メッセージ ボックスには、[ 再試行 ] ボタンと [キャンセル] ボタンが含まれています。
MB_YESNO
 メッセージ ボックスには、[ はい ] ボタンと [いいえ] ボタンが含まれています。
MB_YESNOCANCEL
 メッセージ ボックスには、[ はい]、[ いいえ]、[ キャンセル] ボタンが含まれています。
 
メッセージ ボックス IconTypesFlag 意味
MB_ICONEXCLAMATION、MB_ICONWARNING
 感嘆符がメッセージ ボックスに表示されます。
MB_ICONINFORMATION、MB_ICONASTERISK
 情報記号がメッセージ ボックスに表示されます。
MB_ICONQUESTION
 メッセージ ボックスに疑問符が表示されます。
MB_ICONSTOP、MB_ICONERROR、MB_ICONHAND
 メッセージ ボックスに停止記号が表示されます。
 
既定の ButtonsFlag 意味
MB_DEFBUTTON1
 最初のボタンは既定のボタンです。
MB_DEFBUTTON2
 2 番目のボタンは既定のボタンです。
MB_DEFBUTTON3
 3 番目のボタンは既定のボタンです。
 
メッセージ TypesFlag をインストールする 意味
INSTALLMESSAGE_FATALEXIT
 早期終了
INSTALLMESSAGE_ERROR
 書式設定されたエラー メッセージ
INSTALLMESSAGE_WARNING
 書式設定された警告メッセージ
INSTALLMESSAGE_USER
 ユーザー要求メッセージ。
INSTALLMESSAGE_INFO
 ログに関する情報メッセージ
INSTALLMESSAGE_FILESINUSE
 置き換える前に閉じる必要がある現在使用中のファイルの一覧。
INSTALLMESSAGE_RESOLVESOURCE
 有効なソースの場所を決定する要求
INSTALLMESSAGE_RMFILESINUSE
 置き換える前に閉じる必要がある現在使用中のファイルの一覧。 Windows インストーラー 4.0 以降で使用できます。 詳細については、「外部 UI での Restart Manager の使用」を参照してください。
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。 既定のインストール メッセージの種類はありません。メッセージの種類は常に指定されます。

szMessage

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

戻り値

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

IDOK

 
IDCANCEL
 
IDABORT
 
IDRETRY
 
IDIGNORE
 
IDYES
 
IDNO

注釈

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

注意

msi.h ヘッダーは、INSTALLUI_HANDLERをエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Server 2012、Windows 8、Windows Server 2008 R2、または Windows 7 の Windows インストーラー 5.0。 Windows Server 2008 または Windows Vista の Windows インストーラー 4.0 または Windows インストーラー 4.5。 Windows Server 2003 または Windows XP の Windows インストーラー
対象プラットフォーム Windows
ヘッダー msi.h

こちらもご覧ください

MsiSetExternalUI