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

Статья
08/24/2023

Функция MsiEnumProducts перечисляет все продукты, объявленные или установленные в данный момент. Перечисляются продукты, устанавливаемые как в контексте установки для пользователя, так и в контексте установки компьютера, а также в объявлениях.

Синтаксис

UINT MsiEnumProductsA(
  [in]  DWORD iProductIndex,
  [out] LPSTR lpProductBuf
);

Параметры

[in] iProductIndex

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

[out] lpProductBuf

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

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

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

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

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

Примечание

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

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

Определение контекста установки

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