SetupWriteTextLogError 函式 (setupapi.h)

SetupWriteTextLogError 函式會將 SetupAPI 特定錯誤或 Win32 系統錯誤的相關信息寫入 SetupAPI 文字記錄檔。

語法

WINSETUPAPI VOID SetupWriteTextLogError(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        LogFlags,
  [in] DWORD        Error,
  [in] PCSTR        MessageStr,
       ...          
);

參數

[in] LogToken

系統定義的 記錄令牌 ，或 由 SetupGetThreadLogToken 傳回的記錄令牌。

[in] Category

DWORD 類型的值，表示記錄專案的事件類別目錄。 可為記錄專案指定的事件類別目錄，與可針對文字記錄啟用的事件類別目錄相同。 如需事件類別目錄的清單，請參閱 為 SetupAPI 文字記錄啟用事件類別目錄。

[in] LogFlags

類型為 DWORD 的值，其為旗標值的位 OR，指定下列專案：

• 記錄專案的事件層級。 可為記錄專案指定的事件層級，與可針對文字記錄啟用的事件層級相同。 如需事件層級旗標的清單，請參閱 設定文字記錄的事件層級。
• 是否要在記錄專案中包含時間戳。 時間戳旗標值是TXTLOG_TIMESTAMP。
• 如果有任何變更，則變更為區段的縮排深度和目前的記錄專案。 如需如何使用縮排旗標的資訊，請參閱 撰寫縮排記錄專案。

[in] Error

SetupAPI 特定的錯誤碼或 Win32 錯誤碼。 SetupAPI 特定的錯誤碼列在 Setupapi.h 中。 Win32 錯誤碼列在 Winerror.h 中。

[in] MessageStr

NULL 終止常數位串的指標，其中包含 與 printf 相容的格式字串，指定要包含在記錄專案中的格式化訊息。

...

逗號分隔參數清單，符合 MessageStr 所提供之格式字串中的格式規範。

傳回值

無

備註

如果安裝應用程式有 SetupAPI 特定的錯誤碼或與安裝錯誤相關聯的 Win32 錯誤碼，應用程式可以呼叫 SetupWriteTextLogError ，而不是 SetupWriteTextLog ，將兩個專案寫入文字記錄檔。 第一個專案會與 SetupWriteTextLog 所撰寫的專案相同，而第二個專案會記錄錯誤碼和錯誤的用戶易記描述。

呼叫端提供的記錄標記、事件類別和旗標會影響 SetupWriteTextLogError 作業的方式，與 SetupWriteTextLog 中所述的方式相同。

SetupWriteTextLogError 會以下列格式寫入第一個記錄專案：

entry-prefixtime_stamp categoryindentationformatted-message

SetupWriteTextLogError 會以下列格式寫入第二個記錄專案：

entry-prefixtime_stampcategoryindentationError：error-numbererror-description

其中：

• 專案前置詞、時間戳、類別、縮排和格式化訊息欄位與文字記錄檔區段本文格式中所述的欄位相同。
• 錯誤號碼欄位包含錯誤號碼。
• error-description 字段包含錯誤的用戶易記描述。

如需 SetupWriteTextLogError 作業的詳細資訊，請參閱 呼叫 SetupWriteTextLogError。

如需記錄令牌的詳細資訊，請參閱 記錄令牌。

如需使用記錄令牌的詳細資訊，請參閱 設定和取得線程的記錄令牌。

規格需求

另請參閱

SetupGetThreadLogToken

SetupWriteTextLog