Функция SetupWriteTextLogError (setupapi.h)

Статья
03/01/2024

Функция 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, представляющее собой побитовое ИЛИ значений флагов, которые указывают следующее:

Уровень событий для записи журнала. Уровни событий, которые можно указать для записи журнала, совпадают с уровнями, которые можно включить для текстового журнала. Список флагов уровня событий см. в разделе Настройка уровня событий для текстового журнала.
Указывает, следует ли включать метку времени в запись журнала. Значение флага метки времени TXTLOG_TIMESTAMP.
Изменение (при наличии) глубины отступов раздела и текущей записи журнала. Сведения об использовании флагов отступов см. в разделе Запись записей журнала с отступами.

[in] Error

Код ошибки, зависят от SetupAPI или код ошибки Win32. Коды ошибок, относящихся к SetupAPI, перечислены в файле Setupapi.h. Коды ошибок Win32 перечислены в файле Winerror.h.

[in] MessageStr

Указатель на константную строку, завершающуюся значением NULL, которая содержит строку формата, совместимую с printf, которая указывает форматированное сообщение, включающееся в запись журнала.

...

Список параметров с разделителями-запятыми, соответствующий описателям формата в строке формата, предоставленной MessageStr.

Возвращаемое значение

None

Remarks

Если в приложении установки есть код ошибки, связанный с SetupAPI, или код ошибки Win32, связанный с ошибкой установки, приложение может вызвать SetupWriteTextLogError вместо SetupWriteTextLog для записи двух записей в текстовый журнал. Первая запись будет такой же, как и в SetupWriteTextLog , а вторая запись будет регистрировать код ошибки и понятное описание ошибки.

Маркер журнала, категория событий и флаги, которые предоставляет вызывающий объект, влияют на работу SetupWriteTextLogError так же, как описано для SetupWriteTextLog.

SetupWriteTextLogError записывает первую запись журнала в следующем формате:

отступ категории с префиксом entry-prefixtime_stampformatted-message

SetupWriteTextLogError записывает вторую запись журнала в следующем формате:

entry-prefixtime_stampотступ категорииОшибка:error-numbererror-description

Где:

Поля префикса записи, метки времени, категории, отступа и форматированного сообщения совпадают с полями, описанными в разделе Форматирование текста раздела текстового журнала.
Поле error-number содержит номер ошибки.
Поле error-description содержит понятное описание ошибки.

Общие сведения о записи записей журнала в текстовых журналах setupAPI см. в разделе Ведение журнала SetupAPI (Windows Vista).

Дополнительные сведения об операции SetupWriteTextLogError см. в разделе Вызов SetupWriteTextLogError.

Дополнительные сведения о маркерах журнала см. в разделе Маркеры журнала.

Дополнительные сведения об использовании маркеров журнала см. в разделе Настройка и получение маркера журнала для потока.

Требования

Требование	Значение
Минимальная версия клиента	Доступно в Windows Vista и более поздних версиях Windows.
Целевая платформа	Персональный компьютер
Верхняя часть	setupapi.h (включая Setupapi.h)
Библиотека	Setupapi.lib

См. также раздел

SetupGetThreadLogToken

SetupWriteTextLog

Поделиться через