MsiGetComponentStateA 関数 (msiquery.h)

  • [アーティクル]

MsiGetComponentState 関数は、コンポーネントの状態を取得します。

構文

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

パラメーター

[in] hInstall

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

[in] szComponent

製品内のコンポーネント名を指定する null で終わる文字列。

[out] piInstalled

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

値 意味
INSTALLSTATE_ABSENT
 コンポーネントがインストールされていません。
INSTALLSTATE_DEFAULT
 コンポーネントは、既定の場所 (ローカルまたはソース) にインストールされます。
INSTALLSTATE_LOCAL
 コンポーネントはローカル ドライブにインストールされます。
INSTALLSTATE_REMOVED
 コンポーネントが削除されています。 アクション状態であり、設定可能ではありません。
INSTALLSTATE_SOURCE
 コンポーネントは、ソース、CD-ROM、またはネットワークから実行されます。
INSTALLSTATE_UNKNOWN
 認識できない製品または機能名が関数に渡されました。

[out] piAction

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

戻り値

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

注釈

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

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

注意

msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして MsiGetComponentState を定義します。 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

こちらもご覧ください

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

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