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 資料行的值。 否則,它必須是 [目錄] 數據行的值。
[out] szPathBuf
接收 null 終止完整目標路徑之緩衝區的指標。 請勿嘗試藉由傳入 szPathBuf的 null (value=0) 來判斷緩衝區的大小。 您可以傳入空字串來取得緩衝區的大小(例如 “” )。 然後,函式會傳回ERROR_MORE_DATA,pcchPathBuf 包含TCHAR中所需的緩衝區大小,不包括終止的Null字元。 傳回ERROR_SUCCESS時,pcchPathBuf 包含寫入緩衝區的TCHAR數目,不包括終止的 Null 字元。
[in, out] pcchPathBuf
指定變數的指標,在
傳回值
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 |
目標平臺 | 窗戶 |
標頭 | msiquery.h |
連結庫 | Msi.lib |
DLL | Msi.dll |