msiGetTargetPathA 函式 (msiquery.h)

  • 發行項

MsiGetTargetPath函式會傳回Directory 資料表中資料夾的完整目標路徑。

語法

UINT MsiGetTargetPathA(
  [in]      MSIHANDLE hInstall,
  [in]      LPCSTR    szFolder,
  [out]     LPSTR     szPathBuf,
  [in, out] LPDWORD   pcchPathBuf
);

參數

[in] hInstall

處理提供給 DLL 自訂動作的安裝，或透過 MsiOpenPackage、 MsiOpenPackageEx或 MsiOpenProduct取得。

[in] szFolder

以 Null 結束的字串，指定 Directory 資料表的記錄。 如果目錄是根目錄，這可以是 DefaultDir 資料行中的值。 否則，它必須是 Directory 資料行中的值。

[out] szPathBuf

接收 Null 終止完整目標路徑之緩衝區的指標。 請勿嘗試藉由傳入 szPathBuf的 null (value=0) 來判斷緩衝區的大小。 您可以藉由傳入空字串 (來取得緩衝區的大小，例如 「」) 。 然後函式會傳回 ERROR_MORE_DATA， 而 pcchPathBuf 包含 TCHAR 中所需的緩衝區大小，不包括終止的 Null 字元。 在傳回ERROR_SUCCESS時， pcchPathBuf 包含寫入緩衝區的 TCHAR 數目，不包括終止的 Null 字元。

[in, out] pcchPathBuf

指定變數 szPathBuf 所指向緩衝區大小之變數的指標 szPathBuf 當函式傳回ERROR_SUCCESS時，此變數包含複製到szPathBuf的資料大小，不包括終止 Null 字元。 如果 szPathBuf 不夠大，函式會傳回ERROR_MORE_DATA並儲存必要的大小，不包括 pcchPathBuf指向的變數中的終止 Null 字元。

傳回值

MsiGetTargetPath函式會傳回下列值：

備註

如果傳回ERROR_MORE_DATA，則為指標的參數會提供保存字串所需的緩衝區大小。 如果傳回ERROR_SUCCESS，它會提供寫入字串緩衝區的字元數。 因此，您可以傳入空字串 (，例如指定緩衝區之參數的 「」) ，以取得緩衝區的大小。 請勿嘗試藉由傳入 Null (value=0) 來判斷緩衝區的大小。

呼叫此函式之前，安裝程式必須先執行 CostInitialize 巨集指令、 FileCost 巨集指令和 CostFinalize 動作。 如需詳細資訊，請參閱 從程式呼叫資料庫函式。

如果目標目前的位置無法使用安裝，MsiGetTargetPath會傳回套件中撰寫之目標目錄的預設路徑。 例如，如果在 維護安裝 期間無法使用網路位置的目標目錄，安裝程式會將目標目錄路徑重設為預設值。 若要取得目標目錄的實際路徑，在此情況下，請呼叫 MsiProvideComponent ，以取得先前已安裝到搜尋目錄中的元件，並將 dwInstallMode 設定為 INSTALLMODE_NODETECTION。

如需詳細資訊，請參閱 從程式呼叫資料庫函式。

如果函式失敗，您可以使用 MsiGetLastErrorRecord來取得擴充的錯誤資訊。

注意

msiquery.h 標頭會將 MsiGetTargetPath 定義為別名，根據 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
標頭 msiquery.h
程式庫 Msi.lib
Dll Msi.dll

另請參閱

安裝程式位置函式

傳遞 Null 作為 Windows Installer 函式的引數