MsiLocateComponentA 関数 (msi.h)

  • [アーティクル]

MsiLocateComponent 関数は、製品コードなしでインストールされているコンポーネントへの完全なパスを返します。 この関数は 、MsiGetProductCode を使用して製品の特定を試みますが、呼び出し元に適した製品を見つけることは保証されません。 可能であれば、MsiGetComponentPath を常に呼び出す必要があります。

構文

INSTALLSTATE MsiLocateComponentA(
  [in]      LPCSTR  szComponent,
  [out]     LPSTR   lpPathBuf,
  [in, out] LPDWORD pcchBuf
);

パラメーター

[in] szComponent

配置するコンポーネントのコンポーネント ID を指定します。

[out] lpPathBuf

コンポーネントへのパスを受け取る変数へのポインター。 変数には、終端の null 文字が含まれます。

[in, out] pcchBuf

lpPathBuf パラメーターが指すバッファーのサイズを文字数で指定する変数へのポインター。 入力時には、終端の null 文字のスペースを含む、バッファーのフルサイズです。 MsiLocateComponent 関数が成功すると、pcchBuf が指す変数には、終端の null 文字を含まない文字数が含まれます。 渡されたバッファーのサイズが小さすぎる場合、関数は INSTALLSTATE_MOREDATAを返します。

lpPathBuf が null の場合、pcchBuf は null にすることができます。

戻り値

値 意味
INSTALLSTATE_NOTUSED
 要求されているコンポーネントは、コンピューター上で無効になっています。
INSTALLSTATE_ABSENT
 コンポーネントがインストールされていません。 「解説」を参照してください。
INSTALLSTATE_INVALIDARG
 関数パラメーターの 1 つが無効です。
INSTALLSTATE_LOCAL
 コンポーネントはローカルにインストールされます。
INSTALLSTATE_MOREDATA
 指定されたバッファーが小さすぎます。
INSTALLSTATE_SOURCE
 コンポーネントは、ソースから実行するためにインストールされます。
INSTALLSTATE_SOURCEABSENT
 コンポーネント ソースにアクセスできません。
INSTALLSTATE_UNKNOWN
 製品コードまたはコンポーネント ID が不明です。 「解説」を参照してください。

Remarks

MsiLocateComponent 関数は、次の理由により、INSTALLSTATE_ABSENTまたはINSTALL_STATE_UNKNOWNを返す場合があります。

  • INSTALLSTATE_ABSENT

    アプリケーションは、MsiUseFeature と必要に応じて MsiConfigureFeature を呼び出すことによって、機能がインストールされたことを正しく確認できませんでした。

  • INSTALLSTATE_UNKNOWN

    この機能は公開されていません。 アプリケーションでは、 MsiQueryFeatureState または MsiEnumFeatures を呼び出して、これを以前に決定 しておく必要があります。 アプリケーションは、初期化中にこれらの呼び出しを行います。 アプリケーションでは、公開されていることがわかっている機能のみを使用する必要があります。 INSTALLSTATE_UNKNOWNは MsiUseFeature によっても返される必要があるため、 MsiUseFeature が呼び出されなかったか、その戻り値が正しくチェックされませんでした。

注意

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

こちらもご覧ください

コンポーネント固有の関数