MsiGetProductInfoA 関数 (msi.h)

MsiGetProductInfo 関数は、公開およびインストールされている製品の製品情報を返します。

構文

UINT MsiGetProductInfoA(
  [in]      LPCSTR  szProduct,
  [in]      LPCSTR  szAttribute,
  [out]     LPSTR   lpValueBuf,
  [in, out] LPDWORD pcchValueBuf
);

パラメーター

[in] szProduct

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

[in] szAttribute

取得するプロパティを指定します。

必須プロパティは使用可能であることが保証されますが、そのプロパティが設定されている場合にのみ他のプロパティを使用できます。 詳細については、「 プロパティで定義されているインターフェイスのプライベート C++ 固有の実装です。 次の一覧のプロパティは、インストールされているアプリケーションからのみ取得できます。

インストールされているアプリケーションから製品 ID、登録済み所有者、または登録済み会社を取得するには、 szProperty を次のいずれかのテキスト文字列値に設定します。

製品のインスタンスの種類を取得するには、 szProperty を次の値に設定します。 このプロパティは、アドバタイズまたはインストールされた製品で使用できます。

次の一覧のアドバタイズされたプロパティは、アドバタイズまたはインストールされているアプリケーションから取得できます。

[out] lpValueBuf

プロパティ値を受け取るバッファーへのポインター。 このパラメーターには、null を指定できます。

[in, out] pcchValueBuf

lpValueBuf パラメーターが指すバッファーのサイズを文字数で指定する変数へのポインター。 入力時には、終端の null 文字のスペースを含む、バッファーのフルサイズです。 渡されたバッファーが小さすぎる場合、返されるカウントには終端の null 文字は含まれません。

lpValueBuf が null の場合、pcchValueBuf は null にすることができます。 この場合、関数は プロパティが製品に正しく登録されていることを確認します。

戻り値

注釈

MsiGetProductInfo 関数が返されると、pcchValueBuf パラメーターにはバッファーに格納されている文字列の長さが含まれます。 返されるカウントには、終端の null 文字は含まれません。 バッファーの大きさが十分でない場合、 MsiGetProductInfo は ERROR_MORE_DATAを返し、 pcchValueBuf には文字列のサイズ (文字数) が含まれますが、null 文字はカウントされません。

MsiGetProductInfo(INSTALLPROPERTY_LOCALPACKAGE) は、キャッシュされたパッケージへのパスを必ずしも返すわけではありません。 キャッシュされたパッケージは内部でのみ使用されます。 メンテナンス モードのインストールは、 MsiConfigureFeature、 MsiConfigureProduct、または MsiConfigureProductEx 関数を使用して呼び出す必要があります。

MsiGetProductInfo を使用して、インストールされている製品でのみ使用できるプロパティについてアドバタイズされた製品に対してクエリを実行しようとすると、関数は ERROR_UNKNOWN_PROPERTYを返します。 たとえば、アプリケーションがアドバタイズされ、インストールされていない場合、INSTALLPROPERTY_INSTALLLOCATION プロパティのクエリは ERROR_UNKNOWN_PROPERTY のエラーを返します。

要件

こちらもご覧ください

インストール コンテキストの決定

Windows インストーラー 2.0 以前ではサポートされていません

システム状態関数