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

Функция MsiEnumRelatedProducts перечисляет продукты с указанным кодом обновления. Эта функция выводит список установленных и объявленных продуктов, имеющих указанное свойство UpgradeCode в таблице Property.

Синтаксис

UINT MsiEnumRelatedProductsA(
  [in]  LPCSTR lpUpgradeCode,
  [in]  DWORD  dwReserved,
  [in]  DWORD  iProductIndex,
  [out] LPSTR  lpProductBuf
);

Параметры

[in] lpUpgradeCode

Строка, завершающаяся значением NULL, указывающая код обновления связанных продуктов, перечисляемых установщиком.

[in] dwReserved

Этот параметр зарезервирован и должен иметь значение 0.

[in] iProductIndex

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

[out] lpProductBuf

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

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

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

Комментарии

См. раздел Свойство UpgradeCode .

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

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

Примечание

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