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

Статья
08/26/2023

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

Синтаксис

WINSETUPAPI VOID SetupWriteTextLog(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        Flags,
  [in] PCSTR        MessageStr,
       ...          
);

Параметры

[in] LogToken

Маркер журнала, который является системным маркером журнала или возвращен программой SetupGetThreadLogToken.

[in] Category

Значение типа DWORD, указывающее категорию событий для записи журнала. Категории событий, которые можно указать для записи журнала, совпадают с категориями событий, которые можно включить для текстового журнала. Список категорий событий см. в разделе Включение категорий событий для текстового журнала SetupAPI.

[in] Flags

Значение типа DWORD, представляющее побитовое ИЛИ значений флага, которые указывают следующее:

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

[in] MessageStr

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

...

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

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

None

Remarks

Если значение LogToken было возвращено вызовом SetupGetThreadLogToken и можно найти соответствующий текстовый раздел журнала, SetupWriteTextLog записывает запись журнала в этот текстовый раздел журнала. Если SetupWriteTextLog не может найти раздел, SetupWriteTextLog записывает запись журнала в соответствующий текстовый журнал, но не включает запись журнала в раздел.

Если значение LogToken является одним из системных маркеров журнала, перечисленных в следующей таблице, SetupWriteTextLog выполняет операцию записи, указанную для этого маркера журнала.

Системный маркер журнала	Операция записи
LOGTOKEN_NOLOG	Запись журнала не записывается в текстовый журнал.
LOG_TOKEN_UNSPECIFIED	Запись журнала записывается в текстовый журнал установки приложения. Запись журнала не включается в текстовый раздел журнала.
LOGTOKEN_SETUPAPI_APPLOG	Запись журнала записывается в текстовый журнал установки приложения. Запись журнала не включается в текстовый раздел журнала.
LOGTOKEN_SETUPAPI_DEVLOG	Запись журнала записывается в текстовый журнал установки устройства. Запись журнала не включается в текстовый раздел журнала.

Примечание Установка значения LogToken для одного из системных маркеров журнала не изменяет значение текущего маркера журнала для потока.

Кроме того, SetupWriteTextLog не записывает запись журнала, если выполняется любое из следующих значений:

Уровень событий, заданный для текстового журнала, меньше, чем уровень событий, заданный для записи журнала.
Категория событий для записи журнала не включена для текстового журнала. Дополнительные сведения о категориях событий см. в разделе Включение категорий событий для текстового журнала.

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

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

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

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

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

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

Требования

Требование	Значение
Минимальная версия клиента	Доступно в Windows Vista и более поздних версиях Windows.
Целевая платформа	Персональный компьютер
Верхняя часть	setupapi.h (включая Setupapi.h)
Библиотека	Setupapi.lib
Набор API	ext-ms-win-setupapi-logging-l1-1-0 (представлено в Windows 8)

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

SetupGetThreadLogToken

SetupWriteTextLogError

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