MsiSetInternalUI 関数 (msi.h)

  • [アーティクル]

MsiSetInternalUI 関数を使用すると、インストーラーの内部ユーザー インターフェイスが有効になります。 次に、このユーザー インターフェイスは、このプロセスでユーザー インターフェイスを生成するインストーラー関数に対する後続のすべての呼び出しに使用されます。 詳細については、「ユーザー インターフェイスのレベル」を参照してください。

構文

INSTALLUILEVEL MsiSetInternalUI(
  [in]      INSTALLUILEVEL dwUILevel,
  [in, out] HWND           *phWnd
);

パラメーター

[in] dwUILevel

ユーザー インターフェイスの複雑さのレベルを指定します。 このパラメーターには、次の値のいずれかを指定できます。

値 説明
INSTALLUILEVEL_FULL
 ウィザード、進行状況、エラーを含む作成されたユーザー インターフェイス。
INSTALLUILEVEL_REDUCED
 ウィザード のダイアログ ボックスが非表示の作成されたユーザー インターフェイス。
INSTALLUILEVEL_BASIC
 簡単な進行状況とエラーの処理。
INSTALLUILEVEL_DEFAULT
 インストーラーは、適切なユーザー インターフェイス レベルを選択します。
INSTALLUILEVEL_NONE
 [完全サイレント インストール]。 これには、必要な場合でも昇格プロンプトの抑制が含まれます。 ユーザー が 昇格できるようにする場合は、「INSTALLUILEVEL_UACONLY」を参照してください。
INSTALLUILEVEL_ENDDIALOG
 前の値のいずれかと組み合わせると、インストーラーでは正常なインストールが終了するか、エラーが発生した場合にモーダル ダイアログ ボックスが表示されます。 ユーザーが取り消した場合は、ダイアログ ボックスは表示されません。
INSTALLUILEVEL_PROGRESSONLY
 INSTALLUILEVEL_BASIC値と組み合わせると、インストーラーには単純な進行状況ダイアログ ボックスが表示されますが、モーダル ダイアログ ボックスやエラー ダイアログ ボックスは表示されません。
INSTALLUILEVEL_NOCHANGE
 UI レベルに変更はありません。 ただし、 phWnd が Null でない場合は、親ウィンドウが変更される可能性があります。
INSTALLUILEVEL_HIDECANCEL
 INSTALLUILEVEL_BASIC値と組み合わせると、インストーラーには単純な進行状況ダイアログ ボックスが表示されますが、ダイアログに [キャンセル] ボタンは表示されません。 これにより、ユーザーはインストールを取り消すことができなくなります。
INSTALLUILEVEL_SOURCERESONLY
 この値を INSTALLUILEVEL_NONE 値と組み合わせると、インストーラーにはソース解決に使用されるダイアログ ボックスのみが表示されます。 他のダイアログ ボックスは表示されません。 UI レベルが INSTALLUILEVEL_NONEされていない場合、この値は無効です。 ソース解決を除くすべての UI を処理するように設計された外部ユーザー インターフェイスと共に使用されます。 この場合、インストーラーはソース解決を処理します。
INSTALLUILEVEL_UACONLY
 INSTALLUILEVEL_NONE値と組み合わせると、必要な場合は昇格のプロンプトを除き、インストールは完全にサイレントになります。

[in, out] phWnd

ウィンドウへのポインター。 このウィンドウは、作成されたすべてのユーザー インターフェイスの所有者になります。 ユーザー インターフェイスの以前の所有者へのポインターが返されます。 このパラメーターが null の場合、ユーザー インターフェイスの所有者は変更されません。

戻り値

前のユーザー インターフェイス レベルが返されます。 無効な dwUILevel が渡された場合は、 INSTALLUILEVEL_NOCHANGE が返されます。

解説

MsiSetInternalUI 関数は、インストーラーでユーザー インターフェイスを表示する必要がある場合に便利です。 たとえば、機能がインストールされていても、ソースが挿入する必要があるコンパクト ディスクである場合、インストーラーはコンパクト ディスクの入力をユーザーに求めます。インストールの性質によっては、アプリケーションに進行状況インジケーターが表示されたり、ユーザーに情報を照会したりする場合もあります。

Msi.dll が読み込まれると、ユーザー インターフェイス レベルが DEFAULT に設定され、ユーザー インターフェイスの所有者が 0 に設定されます (つまり、初期ユーザー インターフェイスの所有者はデスクトップです)。

要件

   
サポートされている最小のクライアント 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 インストーラーのバージョンで必要な最小 Windows サービス パックに関する情報については、Windows インストーラーの実行時の要件に関する記事を参照してください。
対象プラットフォーム Windows
ヘッダー msi.h
Library Msi.lib
[DLL] Msi.dll

関連項目

インターフェイス関数とログ関数