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

Статья
11/20/2024

Функция 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".
целевая платформа	Виндоус
заголовка	msi.h
библиотеки	Msi.lib
DLL	Msi.dll

См. также

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

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