Функция SetupQueryFileLogA (setupapi.h)
[Эта функция доступна для использования в операционных системах, указанных в разделе Требования. В последующих версиях он может быть изменен или недоступен. SetupAPI больше не следует использовать для установки приложений. Вместо этого используйте установщик Windows для разработки установщиков приложений. SetupAPI по-прежнему используется для установки драйверов устройств.]
Функция SetupQueryFileLog возвращает сведения из журнала файла установки.
Синтаксис
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. Требуется для несистемных журналов. Если для системного журнала не указано имя logSectionName , предоставляется значение по умолчанию.
[in] TargetFilename
Имя файла, для которого нужны сведения о журнале. Следует использовать строку, завершаемую null.
[in] DesiredInfo
Указывает, какие сведения должны быть возвращены в буфер DataOut . Этот параметр может быть одним из перечисленных ниже значений.
Если значение DesiredInfo больше SetupFileLogOtherInfo , функция завершится ошибкой, а GetLastError вернет ERROR_INVALID_PARAMETER.
[in, out] DataOut
Необязательный указатель на буфер, в котором эта функция возвращает запрошенные сведения для файла. Следует использовать строку, завершаемую null. Строка, завершающаяся значением NULL, не должна превышать размер буфера назначения. Вы можете вызвать функцию один раз, чтобы получить требуемый размер буфера, выделить необходимую память, а затем вызвать функцию второй раз, чтобы получить данные. См. раздел «Примечания». С помощью этого метода можно избежать ошибок из-за недостаточного размера буфера. Не вся информация предоставляется для каждого файла. Ошибка не возвращается, если в журнале существует пустая запись для файла. Этот параметр может принимать значение NULL.
[in] ReturnBufferSize
Размер буфера DataOut в символах. Сюда входит признак конца null . Если буфер слишком мал и указан параметр DataOut , данные не хранятся в буфере и функция возвращает ноль. Если параметр DataOut не указан, параметр ReturnBufferSize игнорируется.
[in, out] RequiredSize
Необязательный указатель на переменную, которая получает требуемый размер DataOut в символах. Это число включает в себя признак конца null .
Возвращаемое значение
Если функция выполняется успешно, возвращаемое значение будет ненулевым.
Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.
Комментарии
Если эта функция вызывается с dataOutсо значением NULL и returnBufferSize равным нулю, функция помещает размер буфера, необходимый для хранения указанных данных, в переменную, на которую указывает параметр RequiredSize. Если функция завершается успешно, возвращаемое значение будет ненулевым. В противном случае возвращаемое значение равно нулю, а расширенные сведения об ошибке можно получить, вызвав Метод GetLastError.
Если значение DesiredInfo больше SetupFileLogOtherInfo , функция завершится ошибкой, а GetLastError вернет ERROR_INVALID_PARAMETER.
Примечание
Заголовок setupapi.h определяет SetupQueryFileLog в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows XP [только классические приложения] |
| Минимальная версия сервера | Windows Server 2003 [только классические приложения] |
| Целевая платформа | Windows |
| Header | setupapi.h |
| Библиотека | Setupapi.lib |
| DLL | Setupapi.dll |