Функция MsiEnumComponentsA (msi.h)

Статья
08/24/2023

Функция MsiEnumComponents перечисляет установленные компоненты для всех продуктов. Эта функция получает один код компонента при каждом вызове.

Синтаксис

UINT MsiEnumComponentsA(
  [in]  DWORD iComponentIndex,
  [out] LPSTR lpComponentBuf
);

Параметры

[in] iComponentIndex

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

[out] lpComponentBuf

Указатель на буфер, который получает код компонента. Этот буфер должен содержать 39 символов. Первые 38 символов предназначены для GUID, а последний — для завершающего символа NULL.

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

Значение	Значение
ERROR_BAD_CONFIGURATION	Данные конфигурации повреждены.
ERROR_INVALID_PARAMETER	В функцию передан недопустимый параметр.
ERROR_NO_MORE_ITEMS	Нет возвращаемых компонентов.
ERROR_NOT_ENOUGH_MEMORY	В системе недостаточно памяти для выполнения операции. Доступно в Windows Server 2003.
ERROR_SUCCESS	Значение перечислено.

Для перечисления компонентов приложение должно сначала вызвать функцию MsiEnumComponents с параметром iComponentIndex , равным нулю. Затем приложение должно увеличить параметр iComponentIndex и вызывать MsiEnumComponents , пока не будет больше компонентов (т. е. пока функция не вернет ERROR_NO_MORE_ITEMS).

При выполнении нескольких вызовов MsiEnumComponents для перечисления всех компонентов продукта каждый вызов должен выполняться из одного потока.

Примечание

Заголовок msi.h определяет MsiEnumComponents в качестве псевдонима, который автоматически выбирает версию 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, необходимом для версии установщика Windows, см. в статье Требования к установщику Windows Run-Time.
Целевая платформа	Windows
Header	msi.h
Библиотека	Msi.lib
DLL	Msi.dll

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

Функции состояния системы