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

Статья
11/20/2024

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

о экземпляре продукта, установленного под учетной записью пользователя, отличной от текущего пользователя.

Вызывающий процесс должен иметь права администратора для пользователя, который отличается от текущего пользователя. Функция MsiGetProductInfoEx не может запрашивать экземпляр продукта, объявленного в контексте, неуправляемом пользователем, для учетной записи пользователя, отличной от текущего пользователя.

Эта функция является расширением функции MsiGetProductInfo.

Синтаксис

UINT MsiGetProductInfoExW(
  [in]                LPCWSTR           szProductCode,
  [in]                LPCWSTR           szUserSid,
  [in]                MSIINSTALLCONTEXT dwContext,
  [in]                LPCWSTR           szProperty,
  [out, optional]     LPWSTR            szValue,
  [in, out, optional] LPDWORD           pcchValue
);

Параметры

[in] szProductCode

Guid ProductCode экземпляра продукта, запрашиваемого.

[in] szUserSid

Идентификатор безопасности учетной записи, в которой существует экземпляр продукта, запрашиваемого. NULL указывает текущий идентификатор безопасности пользователя.

Ид безопасности	Значение
NULL	Вошедший в систему пользователь.
идентификатор безопасности пользователя	Перечисление для конкретного пользователя в системе. Примером идентификатора безопасности пользователя является S-1-3-64-2415071341-135809888-3127455600-2561.

Примечание Специальная строка БЕЗОПАСНОСТИ "S-1-5-18" (система) не может использоваться для перечисления продуктов, установленных как на компьютере. Если dwContext имеет значение "MSIINSTALLCONTEXT_MACHINE", szUserSid должен быть NULL.

[in] dwContext

Контекст установки экземпляра продукта, запрашиваемого.

Имя	Значение
MSIINSTALLCONTEXT_USERMANAGED	Извлекает свойство продукта для управляемого пользователем экземпляра продукта.
MSIINSTALLCONTEXT_USERUNMANAGED	Извлекает свойство продукта для неуправляемого экземпляра продукта на пользователя.
MSIINSTALLCONTEXT_MACHINE	Извлекает свойство продукта для экземпляра каждого компьютера продукта.

[in] szProperty

Свойство запрашивается.

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

Свойство	Значение
INSTALLPROPERTY_PRODUCTSTATE	Состояние продукта, возвращаемого в строковой форме, как "1" для объявленных и "5" для установленных.
INSTALLPROPERTY_HELPLINK	Ссылка на поддержку. Дополнительные сведения см. в свойстве ARPHELPLINK.
INSTALLPROPERTY_HELPTELEPHONE	Телефон поддержки. Дополнительные сведения см. в свойстве ARPHELPTELEPHONE.
INSTALLPROPERTY_INSTALLDATE	Последний раз, когда этот продукт получил службу. Значение этого свойства заменяется при каждом применении исправления или удалении из продукта или параметра /v Command-Line, используется для восстановления продукта. Если продукт не получил исправления или исправления этого свойства содержит время установки этого продукта на этом компьютере.
INSTALLPROPERTY_INSTALLEDLANGUAGE	Установленный язык. Установщик Windows 4.5 и более ранние: не поддерживается.
INSTALLPROPERTY_INSTALLEDPRODUCTNAME	Установленное имя продукта. Дополнительные сведения см. в свойстве ProductName .
INSTALLPROPERTY_INSTALLLOCATION	Расположение установки. Дополнительные сведения см. в свойстве ARPINSTALLLOCATION.
INSTALLPROPERTY_INSTALLSOURCE	Источник установки. Дополнительные сведения см. в свойстве SourceDir .
INSTALLPROPERTY_LOCALPACKAGE	Локальный кэшированный пакет.
INSTALLPROPERTY_PUBLISHER	Издатель. Дополнительные сведения см. в свойстве производителя .
INSTALLPROPERTY_URLINFOABOUT	Сведения о URL-адресе. Дополнительные сведения см. в свойстве ARPURLINFOABOUT.
INSTALLPROPERTY_URLUPDATEINFO	Сведения об обновлении URL-адреса. Дополнительные сведения см. в свойстве ARPURLUPDATEINFO .
INSTALLPROPERTY_VERSIONMINOR	Дополнительная версия продукта, производная от свойства ProductVersion.
INSTALLPROPERTY_VERSIONMAJOR	Основная версия продукта, производная от свойства ProductVersion.
INSTALLPROPERTY_VERSIONSTRING	Версия продукта. Дополнительные сведения см. в свойстве ProductVersion .

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

Ценность	Описание
ProductID	Идентификатор продукта. Дополнительные сведения см. в свойстве ProductID .
RegCompany	Компания, зарегистрированная для использования продукта.
RegOwner	Владелец, зарегистрированный для использования продукта.

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

Ценность	Описание
InstanceType	Отсутствующее значение или значение 0 (ноль) указывает на обычную установку продукта. Значение одного (1) указывает на продукт, установленный с помощью преобразования нескольких экземпляров и свойства MSINEWINSTANCE. Дополнительные сведения см. в установке нескольких экземпляров продуктов и исправлений.

Ценность

Описание

InstanceType

Отсутствующее значение или значение 0 (ноль) указывает на обычную установку продукта. Значение одного (1) указывает на продукт, установленный с помощью преобразования нескольких экземпляров и свойства MSINEWINSTANCE. Дополнительные сведения см. в установке нескольких экземпляров продуктов и исправлений.

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

Свойство	Описание
INSTALLPROPERTY_TRANSFORMS	Преобразует.
INSTALLPROPERTY_LANGUAGE	Язык продукта.
INSTALLPROPERTY_PRODUCTNAME	Имя удобочитаемого продукта. Дополнительные сведения см. в свойстве ProductName .
INSTALLPROPERTY_ASSIGNMENTTYPE	Равно 0 (ноль), если продукт объявлен или установлен на пользователя. Равно одному (1), если продукт объявлен или установлен на компьютер для всех пользователей.
INSTALLPROPERTY_PACKAGECODE	Идентификатор пакета, из который установлен продукт. Дополнительные сведения см. в свойстве кодов пакетов.
INSTALLPROPERTY_VERSION	Версия продукта, полученная из свойства ProductVersion.
INSTALLPROPERTY_PRODUCTICON	Первичный значок пакета. Дополнительные сведения см. в свойстве ARPPRODUCTICON .
INSTALLPROPERTY_PACKAGENAME	Имя исходного пакета установки.
INSTALLPROPERTY_AUTHORIZED_LUA_APP	Значение одного (1) указывает на продукт, который может обслуживаться неадминистраторами с помощью контроля учетных записей пользователей (UAC). Отсутствующее значение или значение 0 (ноль) указывает, что исправление с минимальными привилегиями не включено. Доступно в установщике Windows 3.0 или более поздней версии.

[out, optional] szValue

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

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

Если lpValue и pcchValue задано значение NULL, функция возвращает ERROR_SUCCESS, если значение существует без получения значения.

[in, out, optional] pcchValue

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

Этот параметр можно задать NULL только в том случае, если lpValue также NULL. В противном случае функция возвращает ERROR_INVALID_PARAMETER.

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

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

Возвращаемый код	Описание
ERROR_ACCESS_DENIED	Вызывающий процесс должен иметь права администратора, чтобы получить сведения о продукте, установленном для пользователя, отличного от текущего пользователя.
ERROR_BAD_CONFIGURATION	Данные конфигурации повреждены.
ERROR_INVALID_PARAMETER	Недопустимый параметр передается функции.
ERROR_MORE_DATA	Буфер слишком мал для хранения запрошенных данных.
ERROR_SUCCESS	Функция успешно завершена.
ERROR_UNKNOWN_PRODUCT	Продукт непреднамерен или удален.
ERROR_UNKNOWN_PROPERTY	Свойство не распознается. Примечание Функция MsiGetProductInfo возвращает ERROR_UNKNOWN_PROPERTY, если запрашиваемое приложение объявляется и не установлено.
ERROR_FUNCTION_FAILED	Непредвиденный внутренний сбой.

Замечания

Когда функция msiGetProductInfoEx возвращает msiGetProductEx, параметр pcchValue содержит длину строки, хранимой в буфере. Возвращаемое число не включает завершающийся символ NULL. Если буфер недостаточно велик, MsiGetProductInfoEx возвращает ERROR_MORE_DATA, а параметр pcchValue содержит размер строки в TCHARбез подсчета null символов.

Функция MsiGetProductInfoEx (INSTALLPROPERTY_LOCALPACKAGE) возвращает путь к кэшированному пакету. Кэшированный пакет предназначен только для внутреннего использования. Установка режима обслуживания должна вызываться с помощью MsiConfigureFeature, MsiConfigureProductили Функций MsiConfigureProductEx.

Функция MsiGetProductInfo возвращает ERROR_UNKNOWN_PROPERTY, если запрашиваемое приложение объявляется и не установлено. Например, если приложение объявлено и не установлено, запрос на INSTALLPROPERTY_INSTALLLOCATION возвращает ошибку ERROR_UNKNOWN_PROPERTY.

Заметка

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