Функция MsiGetSummaryInformationA (msiquery.h)

Статья
08/25/2023

Функция MsiGetSummaryInformation получает дескриптор потока _SummaryInformation для базы данных установщика. Эта функция возвращает дескриптор, который должен быть закрыт с помощью MsiCloseHandle.

Синтаксис

UINT MsiGetSummaryInformationA(
  [in]  MSIHANDLE hDatabase,
  [in]  LPCSTR    szDatabasePath,
  [in]  UINT      uiUpdateCount,
  [out] MSIHANDLE *phSummaryInfo
);

Параметры

[in] hDatabase

Дескриптор для базы данных.

[in] szDatabasePath

Указывает путь к базе данных.

[in] uiUpdateCount

Указывает максимальное количество обновленных значений.

[out] phSummaryInfo

Указатель на расположение, из которого будет получен дескриптор сводной информации.

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

Функция MsiGetSummaryInformation возвращает следующие значения:

Если база данных, указанная функцией MsiGetSummaryInformation , не открыта, необходимо указать 0 для hDatabase и указать путь к базе данных в szDatabasePath. Если база данных открыта, необходимо задать для szDatabasePath значение 0.

Если значение uiUpdateCount больше 0 используется для открытия существующего потока сводной информации, перед закрытием дескриптора phSummaryInfoInfoPersist необходимо вызвать MsiSummaryInfoPersist. В противном случае существующие сведения о потоке будут потеряны.

Чтобы просмотреть сводные сведения об исправлении с помощью MsiGetSummaryInformation, задайте для szDatabasePath путь к исправлению. Кроме того, можно создать дескриптор исправления с помощью MsiOpenDatabase , а затем передать этот дескриптор в MsiGetSummaryInformation в качестве параметра hDatabase .

Обратите внимание, что рекомендуется использовать переменные типа PMSIHANDLE, так как установщик закрывает объекты PMSIHANDLE по мере их выхода из область, тогда как необходимо закрыть объекты MSIHANDLE, вызвав MsiCloseHandle. Дополнительные сведения см. в разделе Использование PMSIHANDLE вместо HANDLE статьи Рекомендации установщика Windows.

В случае сбоя функции можно получить расширенные сведения об ошибке с помощью MsiGetLastErrorRecord.

Примечание

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

Требования

Требование	Значение
Минимальная версия клиента	Установщик Windows 5.0 в Windows Server 2012, Windows 8, Windows Server 2008 R2 или Windows 7. Установщик Windows 4.0 или установщик Windows 4.5 в Windows Server 2008 или Windows Vista. Установщик Windows в Windows Server 2003 или Windows XP
Целевая платформа	Windows
Header	msiquery.h
Библиотека	Msi.lib
DLL	Msi.dll

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

Функции свойств сводной информации

Набор свойств Stream сводной информации

Share via