MsiSetFeatureStateA 関数 (msiquery.h)

  • [アーティクル]

MsiSetFeatureState 関数は、機能を指定された状態に設定します。

構文

UINT MsiSetFeatureStateA(
  [in] MSIHANDLE    hInstall,
  [in] LPCSTR       szFeature,
  [in] INSTALLSTATE iState
);

パラメーター

[in] hInstall

DLL カスタム アクションに提供されるインストール、または MsiOpenPackage、MsiOpenPackageEx、または MsiOpenProduct を使用して取得されたインストールを処理します。

[in] szFeature

機能の名前を指定します。

[in] iState

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

値 意味
INSTALLSTATE_ABSENT
 機能がインストールされていません。
INSTALLSTATE_LOCAL
 この機能はローカル ドライブにインストールされます。
INSTALLSTATE_SOURCE
 この機能は、ソース、CD、またはネットワークから実行されます。
INSTALLSTATE_ADVERTISED
 機能はアドバタイズされます。

戻り値

MsiSetFeatureState 関数は、次の値を返します。

注釈

MsiSetFeatureState 関数は、フィーチャー テーブルとその子のフィーチャーの選択状態の変更を要求します。 さらに、変更された特徴レコードにリンクされているすべてのコンポーネントのアクション状態も、新しい特徴選択状態に基づいて適切に更新されます。

MsiSetFeatureState を呼び出す前に、MsiSetInstallLevel 関数を呼び出す必要があります。

MsiSetFeatureState が呼び出されると、インストーラーは、指定した機能に関連付けられている各コンポーネントのアクション状態を指定された状態に設定しようとします。 ただし、要求を完全に実装できない一般的な状況があります。 たとえば、フィーチャーが FeatureComponents テーブルを介してコンポーネント A とコンポーネント B の 2 つのコンポーネントに関連付けられ、コンポーネント A に msidbComponentAttributesLocalOnly 属性があり、コンポーネント B に msidbComponentAttributesSourceOnly 属性がある場合です。 この場合、要求された状態が INSTALLSTATE_LOCAL または INSTALLSTATE_SOURCE の MsiSetFeatureState が呼び出された場合、要求を両方のコンポーネントに対して完全に実装することはできません。 この場合、両方のコンポーネントがオンになり、コンポーネント A が [ローカル] に設定され、コンポーネント B が [ソース] に設定されます。

複数の機能が 1 つのコンポーネントにリンクされている場合 (一般的なシナリオ)、そのコンポーネントの最終的なアクション状態は次のように決定されます。

  • 少なくとも 1 つの機能でコンポーネントをローカルにインストールする必要がある場合、その機能はローカルの状態でインストールされます。
  • 少なくとも 1 つの機能でコンポーネントをソースから実行する必要がある場合、その機能はソースの状態でインストールされます。
  • 少なくとも 1 つの機能でコンポーネントの削除が必要な場合、アクションの状態は存在しません。
「プログラムからのデータベース関数の呼び出し」を参照してください。

関数が失敗した場合は、 MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。

注意

msiquery.h ヘッダーは、MSISetFeatureState をエイリアスとして定義し、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
ヘッダー msiquery.h
Library Msi.lib
[DLL] Msi.dll

こちらもご覧ください

インストーラーの選択関数