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

INSTALLUI_HANDLER_RECORD関数プロトタイプは、インストーラーが進行状況通知とエラー メッセージを呼び出すコールバック関数を定義します。 MsiSetExternalUIRecord 関数を呼び出して、レコードベースの外部ユーザー インターフェイス (UI) ハンドラーを有効にします。

Windows インストーラー 3.0 と Windows インストーラー 2.0: サポートされていません。 Windows インストーラー バージョン 3.1 以降で使用できます。

構文

INSTALLUI_HANDLER_RECORD InstalluiHandlerRecord;

int InstalluiHandlerRecord(
  LPVOID pvContext,
  UINT iMessageType,
  MSIHANDLE hRecord
)
{...}

パラメーター

pvContext

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

iMessageType

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

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

hRecord

レコード オブジェクトへのハンドルを指定します。 レコード オブジェクトの詳細については、「 レコード処理関数」を参照してください。

戻り値

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

IDOK

注釈

この種類の外部 UI ハンドラーは、呼び出し元が関心のあるエラーまたはメッセージの種類がわかっている場合に使用する必要があります。また、INSTALLUI_HANDLER型の外部 UI ハンドラーに送信される文字列メッセージを解析するオーバーヘッドを回避し、hRecord のフィールドから目的のデータを取得する必要があります。

外部ユーザー インターフェイス ハンドラーから値を返す方法の詳細については、「外部ユーザー インターフェイス ハンドラー から値を返す 」トピックを参照してください。 レコード ベースの外部 UI ハンドラーに送信される hRecord オブジェクトは、Windows インストーラーによって所有され、コールバックの有効期間に対してのみ有効です。 コールバックは、必要なデータをレコードから抽出し、そのハンドルを閉じないようにする必要があります。

レコード ベースの外部 UI ハンドラーが hRecord オブジェクト内のデータを変更しようとすると、Windows インストーラーは無視されます。

レコード ベースの外部ハンドラーの使用について詳しくは、「MsiSetExternalUIRecord を使用したインストールの監視」をご覧ください。

要件

こちらもご覧ください

MsiSetExternalUI

Windows Installer 3.0 以前でのサポート対象外