Вызов SetupWriteTextLog

SetupWriteTextLog добавляет одну запись с информацией о событии установки в текстовый журнал SetupAPI.

Как описано в формате тела раздела текстового журнала, формат записи журнала состоит из следующих полей:

entry_prefix time_stamp event_category indentation formatted_message

Чтобы вызвать SetupWriteTextLog, приложение предоставляет следующие сведения:

  • Токен журнала для раздела в текстовом журнале, полученный путем вызова SetupGetThreadLogToken или один из системных токенов журнала. Если маркер журнала связан с текстовым разделом журнала, SetupWriteTextLog записывает запись журнала в этом разделе. В противном случае SetupWriteTextLog добавляет запись журнала в часть журнала, которая не включена в раздел текстового журнала. Кроме того, записывает ли программа SetupWriteTextLog запись журнала и в какой текстовый журнал SetupWriteTextLog записывает запись, зависит от значения токена журнала, определенного системой.

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

  • Одна из категорий событий, описанных в разделе «Включение категорий событий для текстового журнала». Если категория события для этой записи включена для текстового журнала, SetupWriteTextLog добавляет запись в текстовый журнал; в противном случае SetupWriteTextLog не записывает запись в текстовый журнал.

  • Значение флага, которое представляет собой побитовое ИЛИ системных констант, указывающих уровень события, глубину отступа и необходимость включения метки времени. Уровни событий описаны в разделе Настройка уровня событий для текстового журнала. Если для текстового журнала задан уровень событий больше или равен уровню события для записи, SetupWriteTextLog записывает запись журнала в текстовый журнал; в противном случае SetupWriteTextLog не записывает запись журнала в текстовый журнал. Используя отступ, отформатированные сообщения можно упорядочить, чтобы упростить чтение и понимание сведений в разделе. Дополнительные сведения см. в разделе Запись записей журнала с отступами.

  • Строка формата, совместимая с printf, которая форматирует как сообщение, так и следующий за строкой формата список переменных, разделённых запятыми.

  • Разделенный запятыми список переменных, значения которых форматируются строкой формата, совместимой с printf.

Пример вызова SetupWriteTextLog для записи сведений о событии, которое не является ошибкой или предупреждением, см. в статье "Запись журнала сведений".

Пример вызова SetupWriteTextLog для регистрации сведений об ошибке или предупреждении см. в статье "Запись журнала ошибок или предупреждений".