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

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

Синтаксис

UINT MsiEnumProductsExA(
  [in, optional]      LPCSTR            szProductCode,
  [in]                LPCSTR            szUserSid,
  [in]                DWORD             dwContext,
  [in]                DWORD             dwIndex,
  [out, optional]     CHAR [39]         szInstalledProductCode,
  [out, optional]     MSIINSTALLCONTEXT *pdwInstalledContext,
  [out, optional]     LPSTR             szSid,
  [in, out, optional] LPDWORD           pcchSid
);

Параметры

[in, optional] szProductCode

Код продукта GUID перечисляемого продукта. Перечисляются только экземпляры продуктов в область контекста, заданного параметрами szUserSid и dwContext. Для этого параметра можно задать значение NULL , чтобы перечислить все продукты в указанном контексте.

[in] szUserSid

Строка, завершающаяся значением NULL, которая указывает идентификатор безопасности (SID), ограничивающий контекст перечисления. Специальная строка sid s-1-1-0 (Все) указывает перечисление для всех пользователей в системе. Значение SID, отличное от s-1-1-0, считается идентификатором безопасности пользователя и ограничивает перечисление текущим пользователем или любым пользователем в системе. Для этого параметра можно задать значение NULL, чтобы ограничить область перечисления текущим пользователем.

[in] dwContext

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

[in] dwIndex

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

[out, optional] szInstalledProductCode

Строка TCHAR , завершающаяся null, которая предоставляет идентификатор GUID ProductCode перечисляемого экземпляра продукта. Этот параметр может принимать значение NULL.

[out, optional] pdwInstalledContext

Возвращает контекст перечисляемого экземпляра продукта. Выходные значения могут быть MSIINSTALLCONTEXT_USERMANAGED, MSIINSTALLCONTEXT_USERUNMANAGED или MSIINSTALLCONTEXT_MACHINE. Этот параметр может принимать значение NULL.

[out, optional] szSid

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

Этот буфер должен быть достаточно большим, чтобы содержать идентификатор безопасности. Если буфер слишком мал, функция возвращает ERROR_MORE_DATA и присваивает *pcchSid числу TCHAR в идентификаторе безопасности, не включая завершающий символ NULL.

Если для szSid задано значение NULL , а pcchSid — допустимый указатель, функция возвращает ERROR_SUCCESS и присваивает *pcchSid числу TCHAR в значении, не включая завершающее значение NULL. Затем функцию можно вызвать снова, чтобы получить значение, при этом буфер szSid достаточно большой, чтобы содержать *pcchSid + 1 символов.

Если оба значения szSid и pcchSid имеют значение NULL, функция возвращает ERROR_SUCCESS, если значение существует, без извлечения значения.

[in, out, optional] pcchSid

При вызове функции этот параметр должен быть указателем на переменную, указывающую количество TCHAR в буфере szSid . Когда функция возвращает значение, для этого параметра устанавливается размер запрошенного значения независимо от того, копирует ли функция значение в указанный буфер. Размер возвращается как число TCHAR в запрошенном значении, не включая завершающий символ NULL.

Для этого параметра можно задать значение NULL , только если szSid также имеет значение NULL, в противном случае функция возвращает ERROR_INVALID_PARAMETER.

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

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

Комментарии

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

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

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

Используйте MsiGetProductInfoEx , чтобы получить состояние или другие сведения о каждом экземпляре продукта, перечисляемом MsiEnumProductsEx.

Требования

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

MsiEnumProducts

Не поддерживается в установщике Windows 2.0 и более ранних версий

ProductCode

Удаление исправлений