msiExtractPatchXMLDataA 函式 (msi.h)

  • 發行項

MsiExtractPatchXMLData 函式會從可用來判斷修補程式是否適用於目標系統的修補程式中擷取資訊。 函式會傳回 XML 字串，此字串可以提供給 MsiDeterminePatchSequence 和 MsiDetermineApplicablePatches ，而不是完整的修補程式檔案。 傳回的信息可用來判斷修補程式是否適用。

語法

UINT MsiExtractPatchXMLDataA(
  [in]                LPCSTR  szPatchPath,
  [in]                DWORD   dwReserved,
  [out, optional]     LPSTR   szXMLData,
  [in, out, optional] LPDWORD pcchXMLData
);

參數

[in] szPatchPath

正在查詢之修補程式的完整路徑。 以 Null 終止字串的形式傳入。 此參數不可為 NULL。

[in] dwReserved

必須是 0 (零) 的保留自變數。

[out, optional] szXMLData

緩衝區的指標，用來保存包含所擷取修補程式資訊的 XML 字串。 這個緩衝區應該夠大，足以包含接收的資訊。 如果緩衝區太小，函式會傳回ERROR_MORE_DATA，並將 *pcchXMLData 設定為值中的 TCHAR 數目，不包括終止的 NULL 字元。

如果 szXMLData 設定為 NULL ，而 pcchXMLData 設定為有效的指標，則函式會傳回ERROR_SUCCESS，並將 *pcchXMLData 設定為值中的 TCHAR 數目，不包括終止的 NULL 字元。 然後可以再次呼叫 函式以擷取值， szXMLData 緩衝區夠大，足以包含 *pcchXMLData + 1 個字元。

[in, out, optional] pcchXMLData

指定 szXMLData 緩衝區中 TCHAR 數目的變數指標。 當函式傳回時，不論函式是否將值複製到指定的緩衝區，此參數會設定為要求值的大小。 大小會以要求值中的 TCHAR 數目傳回，不包括終止的 Null 字元。

如果此參數設定為 NULL，函式會傳回ERROR_INVALID_PARAMETER。

傳回值

MsiExtractPatchXMLData 函式可以傳回下列值。

傳回碼 Description
ERROR_FUNCTION_FAILED
 函式失敗，因為此數據表中的任何傳回值都無法識別。
ERROR_INVALID_PARAMETER
 無效的參數已傳遞至 函式。
ERROR_MORE_DATA
 值不適用於提供的緩衝區。
ERROR_PATCH_OPEN_FAILED
 無法開啟修補程式檔案。
ERROR_SUCCESS
 函式成功。
ERROR_PATCH_PACKAGE_INVALID
 無法開啟修補程式檔案。
ERROR_CALL_NOT_IMPLEMENTED
 如果未安裝 MSXML 3.0，則可以傳回此錯誤。

備註

Installer 物件的 ExtractPatchXMLData 方法會使用 MsiExtractPatchXMLData 函式。

注意

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

規格需求

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

另請參閱

MsiDetermineApplicablePatches

MsiDeterminePatchSequence

Windows Installer 2.0 和更早版本中不支援