MsiConfigureProductA 関数 (msi.h)

  • [アーティクル]

MsiConfigureProduct 関数は、製品をインストールまたはアンインストールします。

構文

UINT MsiConfigureProductA(
  [in] LPCSTR       szProduct,
  [in] int          iInstallLevel,
  [in] INSTALLSTATE eInstallState
);

パラメーター

[in] szProduct

構成する製品の製品コードを指定します。

[in] iInstallLevel

製品を既定の状態にインストールするときにインストールする製品の量を指定します。 eInstallState パラメーターが INSTALLSTATE_DEFAULT 以外の値に設定されている場合、iInstallLevel パラメーターは無視され、すべての機能がインストールされます。

このパラメーターには、次の値のいずれかを指定できます。

値 意味
INSTALLLEVEL_DEFAULT
 作成された既定の機能がインストールされます。
INSTALLLEVEL_MINIMUM
 必要な機能のみがインストールされます。 INSTALLLEVEL_MINIMUMとINSTALLLEVEL_MAXIMUMの間の値を指定して、使用可能な機能のサブセットをインストールできます。
INSTALLLEVEL_MAXIMUM
 すべての機能がインストールされています。 INSTALLLEVEL_MINIMUMとINSTALLLEVEL_MAXIMUMの間の値を指定して、使用可能な機能のサブセットをインストールできます。

[in] eInstallState

製品のインストール状態を指定します。 このパラメーターには、次の値のいずれかを指定できます。

値 意味
INSTALLSTATE_LOCAL
 製品は、すべての機能がローカルにインストールされた状態でインストールされます。
INSTALLSTATE_ABSENT
 製品はアンインストールされています。
INSTALLSTATE_SOURCE
 この製品は、ソースから実行するためにすべての機能がインストールされた状態でインストールされます。
INSTALLSTATE_DEFAULT
 製品は、フィーチャー テーブルで指定された既定の状態にインストールされているすべての機能と共にインストール されます。
INSTALLSTATE_ADVERTISED
 製品がアドバタイズされます。

戻り値

値 意味
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されます。
ERROR_SUCCESS
 関数は成功します。
アクションに関連するエラー
 詳細については、エラー コードに関する記事を参照してください。
初期化エラー
 初期化に関連するエラー。

注釈

MsiConfigureProduct 関数は、現在の設定を使用してユーザー インターフェイス (UI) を表示します。 ユーザー インターフェイスの設定は、 MsiSetInternalUI、 MsiSetExternalUI 、 または MsiSetExternalUIRecord を使用して変更できます。

eInstallState パラメーターが INSTALLSTATE_DEFAULT 以外の値に設定されている場合、iInstallLevel パラメーターは無視され、製品のすべての機能がインストールされます。 eInstallState パラメーターが INSTALLSTATE_DEFAULT に設定されていない場合に個々の機能のインストールを制御するには、MsiConfigureFeature を使用します。

注意

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

こちらもご覧ください

複数パッケージのインストール