msiEnableLogA 函式 (msi.h)

  • 發行項

MsiEnableLog 函式會設定呼叫程式中起始之所有後續安裝的記錄模式。

語法

UINT MsiEnableLogA(
  [in] DWORD  dwLogMode,
  [in] LPCSTR szLogFile,
  [in] DWORD  dwLogAttributes
);

參數

[in] dwLogMode

指定記錄模式。 此參數可以是下列一或多個值。

值 意義
INSTALLLOGMODE_FATALEXIT
 記錄記憶體不足或嚴重結束資訊。
INSTALLLOGMODE_ERROR
 記錄錯誤訊息。
INSTALLLOGMODE_EXTRADEBUG
 將額外的偵錯資訊，例如處理建立資訊傳送至記錄檔。

Windows 2000 和 Windows XP： 不支援此功能。
INSTALLLOGMODE_WARNING
 記錄警告訊息。
INSTALLLOGMODE_USER
 記錄使用者要求。
INSTALLLOGMODE_INFO
 記錄未顯示的狀態消息。
INSTALLLOGMODE_RESOLVESOURCE
 判斷有效來源位置的要求。
INSTALLLOGMODE_OUTOFDISKSPACE
 表示磁碟空間不足。
INSTALLLOGMODE_ACTIONSTART
 記錄新安裝動作的開始。
INSTALLLOGMODE_ACTIONDATA
 使用安裝動作記錄數據記錄。
INSTALLLOGMODE_COMMONDATA
 記錄使用者介面初始化的參數。
INSTALLLOGMODE_PROPERTYDUMP
 在終止時記錄屬性值。
INSTALLLOGMODE_VERBOSE
 記錄所有其他記錄模式中的資訊，但 INSTALLLOGMODE_EXTRADEBUG除外。 這會將大量的資訊傳送至記錄檔，對使用者而言並不一定很有用。 可用於技術支援。
INSTALLLOGMODE_LOGONLYONERROR
 系統會收集記錄資訊，但較不常儲存至記錄檔。 這可以改善某些安裝的效能，但大型安裝可能沒有好處。 安裝成功時會移除記錄檔。 如果安裝失敗，所有記錄信息都會儲存至記錄檔。

Windows Installer 2.0： 此記錄模式無法使用。

[in] szLogFile

指定保存記錄檔完整路徑的字串。 輸入 null 會停用記錄，在此情況下會忽略 dwlogmode 。 如果提供路徑， 則 dwlogmode 不得為零。

[in] dwLogAttributes

指定要排清記錄緩衝區的頻率。

值 意義
INSTALLLOGATTRIBUTES_APPEND
 如果設定此值，安裝程式會附加 szLogFile 所指定的現有記錄檔。 如果未設定，則會覆寫 szLogFile 所指定的任何現有記錄檔。
INSTALLLOGATTRIBUTES_FLUSHEACHLINE
 強制在每一行之後排清記錄緩衝區。 如果未設定此值，安裝程式會呼叫 FlushFileBuffers，在 20 行之後排清記錄緩衝區。

傳回值

值 意義
ERROR_INVALID_PARAMETER
 指定了無效的記錄模式。
ERROR_SUCCESS
 此函數已成功。

備註

如需記錄原則的描述，請參閱 系統原則。

使用此函式時，記錄檔位置的路徑必須已經存在。 安裝程式不會建立記錄檔的目錄結構。

注意

msi.h 標頭會將 MsiEnableLog 定義為別名，根據 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

另請參閱

介面和記錄函式

Logging