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

Статья
08/25/2023

Функция MsiSummaryInfoGetProperty получает одно свойство из потока сводной информации.

Примечание Значение значения свойства зависит от того, является ли поток сводных сведений для базы данных установки (.msi файла), преобразования (MST-файла) или исправления (MSP-файл). Дополнительные сведения о свойствах сводной информации см. в разделе Описание сводных свойств и Сводная информация Stream наборе свойств.

Синтаксис

UINT MsiSummaryInfoGetPropertyA(
  [in]      MSIHANDLE hSummaryInfo,
  [in]      UINT      uiProperty,
  [out]     PUINT     puiDataType,
  [out]     LPINT     piValue,
  [out]     FILETIME  *pftValue,
  [out]     LPSTR     szValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

Параметры

[in] hSummaryInfo

Обработка сводных сведений.

[in] uiProperty

Указывает идентификатор свойства summary. Этот параметр может быть идентификатором свойства, указанным в наборе свойств Сводная информация Stream. Эта функция не возвращает значения для свойства PID_DICTIONARY ИЛИ PID_THUMBNAIL.

[out] puiDataType

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

[out] piValue

Получает возвращенные данные целочисленного свойства.

[out] pftValue

Указатель на значение файла.

[out] szValueBuf

Указатель на буфер, который получает значение свойства сводной информации о завершении null. Не пытайтесь определить размер буфера, передав значение NULL (value=0) для szValueBuf. Размер буфера можно получить, передав пустую строку (например, ""). Затем функция возвращает ERROR_MORE_DATA и pcchValueBuf содержит требуемый размер буфера в TCHAR, не включая завершающий символ NULL. При возвращении ERROR_SUCCESS pcchValueBuf содержит количество TCHAR , записанных в буфер, не включая завершающий символ NULL. Этот параметр является пустой строкой, если ошибки отсутствуют.

[in, out] pcchValueBuf

Указатель на переменную, указывающую размер буфера, на который указывает переменная szValueBuf, в TCHAR. Когда функция возвращает ERROR_SUCCESS, эта переменная содержит размер данных, скопированных в szValueBuf, не включая завершающий символ NULL. Если szValueBuf недостаточно велик, функция возвращает ERROR_MORE_DATA и сохраняет требуемый размер, не включая завершающий символ NULL, в переменной, на которую указывает pcchValueBuf.

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

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

Если возвращается ERROR_MORE_DATA, параметр, являющийся указателем, задает размер буфера, необходимый для хранения строки. Если возвращается ERROR_SUCCESS, возвращается количество символов, записанных в буфер строки. Таким образом, можно получить размер буфера, передав пустую строку (например, "") для параметра, указывающего буфер. Не пытайтесь определить размер буфера, передав значение Null (value=0).

Функции установщика Windows, возвращающие данные в предоставленном пользователем расположении памяти, не должны вызываться со значением NULL в качестве значения указателя. Эти функции возвращают строку или данные в виде целочисленных указателей, но возвращают несогласованные значения при передаче null в качестве значения для выходного аргумента. Дополнительные сведения см. в разделе Передача null в качестве аргумента функций установщика Windows.

Сведения о свойстве, возвращаемые функцией MsiSummaryInfoGetProperty , получаются параметром piValue, pftValue или szValueBuf в зависимости от типа значения свойства, указанного в параметре puiDataType .

Примечание

Заголовок msiquery.h определяет MsiSummaryInfoGetProperty в качестве псевдонима, который автоматически выбирает версию 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

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

Передача null в качестве аргумента функций установщика Windows

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

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

Summaryinfo.Property

Share via