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

Статья
11/20/2024

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

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

Синтаксис

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

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

[out] puiDataType

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

[out] piValue

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

[out] pftValue

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

[out] szValueBuf

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

[in, out] pcchValueBuf

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

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

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

Замечания

Если возвращается ERROR_MORE_DATA, параметр, являющийся указателем, дает размер буфера, необходимого для хранения строки. Если возвращается ERROR_SUCCESS, оно дает количество символов, записанных в буфер строки. Таким образом, можно получить размер буфера, передав пустую строку (например, "") для параметра, указывающего буфер. Не пытайтесь определить размер буфера, передав значение NULL (значение=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
целевая платформа	Виндоус
заголовка	msiquery.h
библиотеки	Msi.lib
DLL	Msi.dll

См. также

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

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

набор свойств потока сводной информации

Summaryinfo.Property

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