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

指定具有必要元件之功能的功能標識碼。

[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
 功能標識碼不會識別已知的功能。
ERROR_UNKNOWN_PRODUCT
 產品代碼不會識別已知的產品。
INSTALLSTATE_UNKNOWN
 無法辨識的產品或功能名稱已傳遞至函式。
ERROR_MORE_DATA
 傳回緩衝區溢位。
ERROR_INSTALL_SOURCE_ABSENT
 無法偵測來源。
 

如需詳細資訊，請參閱 顯示的錯誤訊息。

備註

在 MsiProvideComponent 函式成功時，pcchPathBuf 參數會包含 lpPathBuf 中的字串長度。

MsiProvideComponent 函式結合了 MsiUseFeature、MsiConfigureFeature 和 MsiGetComponentPath 的功能。 您可以使用 MsiProvideComponent 函式來簡化呼叫順序。 不過，由於此函式會遞增使用量計數，因此請小心避免不正確的使用量計數。 MsiProvideComponent 函式也提供比個別呼叫系列還少的彈性。

如果應用程式從非預期的情況復原，應用程式可能已經稱為 MsiUseFeature ，並遞增使用量計數。 在此情況下，應用程式應該呼叫 MsiConfigureFeature 而不是 MsiProvideComponent ，以避免再次遞增計數。

INSTALLMODE_EXISTING選項無法與 REINSTALLMODE 旗標搭配使用。

包含損毀檔案或錯誤檔案版本的元件功能必須由用戶明確重新安裝，或讓應用程式呼叫 MsiReinstallFeature。

注意

msi.h 標頭會將 MsiProvideComponent 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows Server 2012、Windows 8、Windows Server 2008 R2 或 Windows 7 上的 Windows Installer 5.0。 Windows Server 2008 或 Windows Vista 上的 Windows Installer 4.0 或 Windows Installer 4.5。 Windows Server 2003 或 Windows XP 上的 Windows Installer。 如需 Windows Installer 版本所需的最低 Windows Service Pack 相關信息，請參閱 Windows Installer Run-Time 需求。
目標平台 Windows
標頭 msi.h
程式庫 Msi.lib
Dll Msi.dll

另請參閱

元件特定函式

多套件安裝