MsiGetFeatureStateA 関数 (msiquery.h)

  • [アーティクル]

MsiGetFeatureState 関数は、機能の要求された状態を取得します。

構文

UINT MsiGetFeatureStateA(
  [in]  MSIHANDLE    hInstall,
  [in]  LPCSTR       szFeature,
  [out] INSTALLSTATE *piInstalled,
  [out] INSTALLSTATE *piAction
);

パラメーター

[in] hInstall

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

[in] szFeature

製品内の機能名を指定します。

[out] piInstalled

返される現在のインストール状態を指定します。 このパラメーターは null にすることはできません。 このパラメーターには、次の値のいずれかを指定できます。

値 説明
INSTALLSTATE_BADCONFIG
 構成データが破損しています。
INSTALLSTATE_INCOMPLETE
 インストールが中断されているか、進行中です。
INSTALLSTATE_SOURCEABSENT
 この機能はソースから実行する必要があり、ソースは使用できません。
INSTALLSTATE_MOREDATA
 戻りバッファーがいっぱいです。
INSTALLSTATE_INVALIDARG
 無効なパラメーターが関数に渡されました。
INSTALLSTATE_UNKNOWN
 認識できない製品または機能が指定されました。
INSTALLSTATE_BROKEN
 機能が壊れています。
INSTALLSTATE_ADVERTISED
 アドバタイズされた機能。
INSTALLSTATE_ABSENT
 この機能はアンインストールされました。
INSTALLSTATE_LOCAL
 この機能はローカル ドライブにインストールされました。
INSTALLSTATE_SOURCE
 この機能は、ソース、CD-ROM、またはネットワークから実行する必要があります。
INSTALLSTATE_DEFAULT
 この機能は、既定の場所 (ローカルまたはソース) にインストールされます。

[out] piAction

インストール セッション中に実行されたアクションを受け取ります。 このパラメーターは null にすることはできません。 戻り値については、「 piInstalled」を参照してください。

戻り値

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

解説

「プログラムからのデータベース関数の呼び出し」を参照してください。

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

注意

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

要件

   
サポートされている最小のクライアント 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

関連項目

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

Windows インストーラー関数の引数として Null を渡す