msiGetSourcePathA 函式 (msiquery.h)

MsiGetSourcePath 函式會傳回 Directory 數據表中資料夾的完整來源路徑。

語法

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

參數

[in] hInstall

處理提供給 DLL 自定義動作的安裝,或透過 MsiOpenPackageMsiOpenPackageExMsiOpenProduct 取得。

[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 所指向緩衝區大小之變數的指標,以 TCHAR 為單位。 當函式傳回ERROR_SUCCESS時,此變數會包含複製到 szPathBuf 的數據大小,不包括終止的 Null 字元。 如果 szPathBuf 不夠大,函式會傳回ERROR_MORE_DATA並儲存必要的大小,不包括 pcchPathBuf 指向的變數中的終止 Null 字元。

傳回值

MsiGetSourcePath 函式會傳回下列值:

備註

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

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

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

注意

msiquery.h 標頭會將 MsiGetSourcePath 定義為別名,根據 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 函式的自變數