MsiQueryFeatureStateExA function

The MsiQueryFeatureStateEx function returns the installed state for a product feature. This function can be used to query any feature of an instance of a product installed under the machine account or any context under the current user account or the per-user-managed context under any user account other than the current user. A user must have administrative privileges to get information for a product installed for a user other than the current user.

Syntax

UINT MsiQueryFeatureStateExA(
  LPCSTR            szProductCode,
  LPCSTR            szUserSid,
  MSIINSTALLCONTEXT dwContext,
  LPCSTR            szFeature,
  INSTALLSTATE      *pdwState
);

Parameters

szProductCode

ProductCode GUID of the product that contains the feature of interest.

szUserSid

Specifies the security identifier (SID) of the account, under which, the instance of the product being queried exists. If dwContext is not MSIINSTALLCONTEXT_MACHINE, a null value specifies the current user.

Type of SID Meaning
NULL
NULL denotes the currently logged on user.
User SID
Specifies enumeration for a particular user in the system. An example of user SID is "S-1-3-64-2415071341-1358098788-3127455600-2561".
 
Note  The special SID string s-1-5-18 (system) cannot be used to enumerate features of products installed as per-machine. If dwContext is MSIINSTALLCONTEXT_MACHINE, szUserSid must be null.
 

dwContext

The installation context of the product instance being queried.

Name Meaning
MSIINSTALLCONTEXT_USERMANAGED
Retrieves the feature state for the per-user-managed instance of the product.
MSIINSTALLCONTEXT_USERUNMANAGED
Retrieves the feature state for the per-user-unmanaged instance of the product.
Note  When the query is made on a product installed under the per-user-unmanaged context for a user account other than the current user, the function fails.
 
MSIINSTALLCONTEXT_MACHINE
Retrieves the feature state for the per-machine instance of the product.

szFeature

Specifies the feature being queried. Identifier of the feature as found in the Feature column of the Feature table.

pdwState

Installation state of the feature for the specified product instance. This parameter can return one of the following or null.

Value Meaning
INSTALLSTATE_ADVERTISED
This feature is advertised.
INSTALLSTATE_LOCAL
The feature is installed locally.
INSTALLSTATE_SOURCE
The feature is installed to run from source.

Return Value

The MsiQueryFeatureStateEx function returns the following values.

Value Meaning
ERROR_ACCESS_DENIED
A user must have administrative privileges to get information for a product installed for a user other than the current user.
ERROR_BAD_CONFIGURATION
The configuration data is corrupt.
ERROR_INVALID_PARAMETER
An invalid parameter was passed to the function.
ERROR_SUCCESS
The function completed successfully.
ERROR_UNKNOWN_FEATURE
The feature ID does not identify a known feature.
ERROR_UNKNOWN_PRODUCT
The product code does not identify a known product.
ERROR_FUNCTION_FAILED
An unexpected internal failure.
 

For more information, see Displayed Error Messages.

Remarks

The MsiQueryFeatureStateEx function does not validate that the feature is actually accessible. The MsiQueryFeatureStateEx function does not validate the feature ID. ERROR_UNKNOWN_FEATURE is returned for any unknown feature ID. When the query is made on a product installed under the per-user-unmanaged context for a user account other than the current user, the function fails. In this case the function returns ERROR_UNKNOWN_FEATURE, or if the product is advertised only (not installed), ERROR_UNKNOWN_PRODUCT is returned.

Requirements

   
Minimum supported client Windows Installer 5.0 on Windows Server 2012, Windows 8, Windows Server 2008 R2 or Windows 7. Windows Installer 4.0 or Windows Installer 4.5 on Windows Server 2008 or Windows Vista. See the Windows Installer Run-Time Requirements for information about the minimum Windows service pack that is required by a Windows Installer version.
Target Platform Windows
Header msi.h
Library Msi.lib
DLL Msi.dll

See Also

Displayed Error Messages

Feature Table

MsiQueryFeatureState

Not Supported in Windows Installer 2.0 and earlier

ProductCode

System Status Functions