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

Статья
11/20/2024

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

Функция setupQueryFile Log возвращает сведения из журнала файлов установки.

Синтаксис

WINSETUPAPI BOOL SetupQueryFileLogA(
  [in]      HSPFILELOG       FileLogHandle,
  [in]      PCSTR            LogSectionName,
  [in]      PCSTR            TargetFilename,
  [in]      SetupFileLogInfo DesiredInfo,
  [in, out] PSTR             DataOut,
  [in]      DWORD            ReturnBufferSize,
  [in, out] PDWORD           RequiredSize
);

Параметры

[in] FileLogHandle

Обработка журнала файлов, возвращаемого SetupInitializeFileLog.

[in] LogSectionName

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

[in] TargetFilename

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

[in] DesiredInfo

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

Ценность	Значение
имя SetupFileLogSourceFile	Имя исходного файла, как оно существует на исходном носителе
SetupFileLogChecksum	Значение контрольной суммы, используемое системным журналом
SetupFileLogDiskTagfile	Имя файла тега источника мультимедиа, содержащего исходный файл.
SetupFileLogDiskDescription	Удобочитаемое пользователем описание носителя, в котором находится исходный файл
SetupFileLogOtherInfo	Дополнительные сведения, связанные с зарегистрированным файлом

Если значение DesiredInfo больше SetupFileLogOtherInfo функция завершится ошибкой, и GetLastError вернет ERROR_INVALID_PARAMETER.

[in, out] DataOut

Необязательный указатель на буфер, в котором эта функция возвращает запрошенные сведения для файла. Следует использовать строку null-terminated. Строка null-terminated не должна превышать размер целевого буфера. Вы можете вызвать функцию один раз, чтобы получить необходимый размер буфера, выделить необходимую память, а затем вызвать функцию во второй раз, чтобы получить данные. См. раздел "Примечания". С помощью этого метода можно избежать ошибок из-за недостаточного размера буфера. Не все сведения предоставляются для каждого файла. Ошибка не возвращается, если в журнале существует пустая запись для файла. Этот параметр может быть NULL.

[in] ReturnBufferSize

Размер буфера dataOut в символах. Это включает в себя null конца. Если буфер слишком мал и dataOut указан, данные не хранятся в буфере, а функция возвращает ноль. Если DataOut не указан, параметр ReturnBufferSize игнорируется.

[in, out] RequiredSize

Необязательный указатель на переменную, которая получает требуемый размер DataOutв символах. Это число включает в себя null конца.

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

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

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

Замечания

Если эта функция вызывается с DataOutNULL и ReturnBufferSize нуля, функция помещает размер буфера, необходимый для хранения указанных данных в переменную, на которую указывает RequiredSize. Если функция выполнена успешно, возвращаемое значение ненулевое значение. В противном случае возвращаемое значение равно нулю и расширенным сведениям об ошибке можно получить путем вызова GetLastError.

Если значение DesiredInfo больше SetupFileLogOtherInfo функция завершится ошибкой, и GetLastError вернет ERROR_INVALID_PARAMETER.

Заметка

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

Требования

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

См. также

Функции

Обзор

SetupLogFile

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