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

Статья
03/01/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. Требуется, если SPFILELOG_SYSTEMLOG не был передан при инициализации журнала файлов. В противном случае этот параметр может иметь значение NULL.

[in] SourceFilename

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

[in] TargetFilename

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

[in] Checksum

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

[in] DiskTagfile

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

[in] DiskDescription

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

[in] OtherInfo

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

[in] Flags

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

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

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

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

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

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	setupapi.h
Библиотека	Setupapi.lib
DLL	Setupapi.dll

См. также

Функции

Обзор

SetupRemoveFileLogEntry

Share via