MsiProvideComponentA 関数 (msi.h)

  • [アーティクル]

MsiProvideComponent 関数は、必要なインストールを実行して、完全なコンポーネント パスを返します。 この関数は、必要に応じてソースの入力を求め、機能の使用数を増やします。

構文

UINT MsiProvideComponentA(
  [in]      LPCSTR  szProduct,
  [in]      LPCSTR  szFeature,
  [in]      LPCSTR  szComponent,
  [in]      DWORD   dwInstallMode,
  [out]     LPSTR   lpPathBuf,
  [in, out] LPDWORD pcchPathBuf
);

パラメーター

[in] szProduct

必要なコンポーネントを含む機能を含む製品の製品コードを指定します。

[in] szFeature

必要なコンポーネントを含むフィーチャーのフィーチャー ID を指定します。

[in] szComponent

必要なコンポーネントのコンポーネント コードを指定します。

[in] dwInstallMode

インストール モードを定義します。 このパラメーターには、次の値のいずれかを指定できます。

値 意味
INSTALLMODE_DEFAULT
 コンポーネントを提供し、コンポーネントを提供するために必要なインストールを実行します。 要求された機能または機能の親のコンポーネントのキー ファイルがない場合は、 MsiReinstallFeature を使用して機能を再インストールし、次のフラグ ビットを設定します:REINSTALLMODE_FILEMISSING、REINSTALLMODE_FILEOLDERVERSION、REINSTALLMODE_FILEVERIFY、REINSTALLMODE_MACHINEDATA、REINSTALLMODE_USERDATA、REINSTALLMODE_SHORTCUT。
INSTALLMODE_EXISTING
 機能が存在する場合にのみ、コンポーネントを提供します。 それ以外の場合は、ERROR_FILE_NOT_FOUNDを返します。

このモードでは、コンポーネントのキー ファイルが存在することを確認します。
INSTALLMODE_NODETECTION
 機能が存在する場合にのみ、コンポーネントを提供します。 それ以外の場合は、ERROR_FILE_NOT_FOUNDを返します。

このモードでは、コンポーネントが登録されていることだけが確認され、コンポーネントのキー ファイルが存在することを確認しません。
REINSTALLMODE フラグの組み合わせ
 msiReinstallFeature を呼び出して、dwReinstallMode パラメーターにこのパラメーターを使用して機能を再インストールし、コンポーネントを指定します。
INSTALLMODE_NOSOURCERESOLUTION
 機能のインストール状態がINSTALLSTATE_LOCAL場合にのみ、コンポーネントを指定します。 機能のインストール状態がINSTALLSTATE_SOURCE場合は、ERROR_INSTALL_SOURCE_ABSENTを返します。 それ以外の場合は、ERROR_FILE_NOT_FOUNDを返します。 このモードでは、コンポーネントが登録されていることだけが確認され、キー ファイルが存在することを確認しません。

[out] lpPathBuf

コンポーネントへのパスを受け取る変数へのポインター。 このパラメーターには、null を指定できます。

[in, out] pcchPathBuf

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

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

戻り値

値 意味
ERROR_BAD_CONFIGURATION
 構成データが破損しています。
ERROR_FILE_NOT_FOUND
 機能が存在しないか、壊れています。 このエラーは dwInstallMode = INSTALLMODE_EXISTINGに対して返されます。
ERROR_INSTALL_FAILURE
 インストールに失敗しました。
ERROR_INSTALL_NOTUSED
 要求されているコンポーネントは、コンピューターで無効になっています。
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
 関数は正常に終了しました。
ERROR_UNKNOWN_FEATURE
 機能 ID では、既知の機能は識別されません。
ERROR_UNKNOWN_PRODUCT
 製品コードでは既知の製品が識別されません。
INSTALLSTATE_UNKNOWN
 認識できない製品または機能名が関数に渡されました。
ERROR_MORE_DATA
 バッファー オーバーフローが返されます。
ERROR_INSTALL_SOURCE_ABSENT
 ソースを検出できません。
 

詳細については、「 表示されたエラー メッセージ」を参照してください。

注釈

MsiProvideComponent 関数が成功すると、pcchPathBuf パラメーターには lpPathBuf 内の文字列の長さが含まれます。

MsiProvideComponent 関数は、MsiUseFeature、MsiConfigureFeature、および MsiGetComponentPath の機能を組み合わせたものです。 MsiProvideComponent 関数を使用すると、呼び出しシーケンスを簡略化できます。 ただし、この関数は使用カウントをインクリメントするため、不正確な使用数を防ぐには注意して使用してください。 また、MsiProvideComponent 関数は、一連の個々の呼び出しよりも柔軟性が低くなります。

アプリケーションが予期しない状況から復旧している場合、アプリケーションは既に MsiUseFeature を呼び出し、使用数を増やしている可能性があります。 この場合、アプリケーションは MsiProvideComponent ではなく MsiConfigureFeature を呼び出して、カウントが再び増加しないようにする必要があります。

INSTALLMODE_EXISTING オプションは、REINSTALLMODE フラグと組み合わせて使用することはできません。

破損したファイルまたは間違ったバージョンのファイルを含むコンポーネントの機能は、ユーザーまたはアプリケーションで MsiReinstallFeature を呼び出すことによって、明示的に再インストールする必要があります。

注意

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

こちらもご覧ください

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

複数パッケージのインストール