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

Статья
11/20/2024

[Эта функция доступна для использования в операционных системах, указанных в разделе "Требования". Он может быть изменен или недоступен в последующих версиях. SetupAPI больше не следует использовать для установки приложений. Вместо этого используйте установщик Windows для разработки установщиков приложений. SetupAPI по-прежнему используется для установки драйверов устройств.]

Функция SetupLogFile добавляет запись в файл журнала.

Синтаксис

WINSETUPAPI BOOL SetupLogFileA(
  [in] HSPFILELOG FileLogHandle,
  [in] PCSTR      LogSectionName,
  [in] PCSTR      SourceFilename,
  [in] PCSTR      TargetFilename,
  [in] DWORD      Checksum,
  [in] PCSTR      DiskTagfile,
  [in] PCSTR      DiskDescription,
  [in] PCSTR      OtherInfo,
  [in] DWORD      Flags
);

Параметры

[in] FileLogHandle

Обработка журнала файлов, возвращаемого SetupInitializeFileLog. Вызывающий объект не должен передавать SPFILELOG_QUERYONLY при инициализации файла журнала.

[in] LogSectionName

Необязательный указатель на имя логической группировки имен в файле журнала. Следует использовать строку null-terminated. Требуется, если SPFILELOG_SYSTEMLOG не переданы при инициализации журнала файлов. В противном случае этот параметр может быть null.

[in] SourceFilename

Имя файла, существующего на исходном носителе, из которого он был установлен. Это имя должно быть в любом формате, понятном вызывающем объекту. Следует использовать строку null-terminated.

[in] TargetFilename

Имя файла, существующего в целевом объекте. Это имя должно быть в любом формате, понятном вызывающем объекту. Следует использовать строку null-terminated.

[in] Checksum

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

[in] DiskTagfile

Необязательный указатель на файл тегов для носителя, из которого был установлен файл. Следует использовать строку null-terminated. Строка null-terminated не должна превышать размер целевого буфера. Игнорируется для системного журнала, если SPFILELOG_OEMFILE не указан. Требуется для системного журнала, если указан SPFILELOG_OEMFILE. В противном случае этот параметр может быть null.

[in] DiskDescription

Необязательный указатель на описание носителя, с которого был установлен файл. Следует использовать строку null-terminated. Игнорируется для системного журнала, если SPFILELOG_OEMFILE не указан в параметре Flags. Требуется для системного журнала, если SPFILELOG_OEMFILE указан в параметре Flags. В противном случае этот параметр может быть null.

[in] OtherInfo

Необязательный указатель на дополнительные сведения, связанные с файлом. Следует использовать строку null-terminated. Этот параметр может быть NULL.

[in] Flags

Этот параметр может быть SPFILELOG_OEMFILE, который имеет смысл только для системного журнала и указывает, что файл не предоставляется корпорацией Майкрософт. Этот параметр можно использовать для преобразования записи существующего файла, например при перезаписи предоставленного корпорацией Майкрософт системного файла oem.

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

Если функция выполнена успешно, возвращаемое значение является ненулевое значение.

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Заметка

Заголовок setupapi.h определяет SetupLogFile как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows Server 2003 [только классические приложения]
целевая платформа	Виндоус
заголовка	setupapi.h
библиотеки	Setupapi.lib
DLL	Setupapi.dll

См. также

Функции

Обзор

SetupRemoveFileLogEntry

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