Edit

Share via

MsiGetFeatureStateW function (msiquery.h)

  • Article

The MsiGetFeatureState function gets the requested state of a feature.

Syntax

UINT MsiGetFeatureStateW(
  [in]  MSIHANDLE    hInstall,
  [in]  LPCWSTR      szFeature,
  [out] INSTALLSTATE *piInstalled,
  [out] INSTALLSTATE *piAction
);

Parameters

[in] hInstall

Handle to the installation provided to a DLL custom action or obtained through MsiOpenPackage, MsiOpenPackageEx, or MsiOpenProduct.

[in] szFeature

Specifies the feature name within the product.

[out] piInstalled

Specifies the returned current installed state. This parameter must not be null. This parameter can be one of the following values.

Value Meaning
INSTALLSTATE_BADCONFIG
 The configuration data is corrupt.
INSTALLSTATE_INCOMPLETE
 The installation is suspended or in progress.
INSTALLSTATE_SOURCEABSENT
 The feature must run from the source, and the source is unavailable.
INSTALLSTATE_MOREDATA
 The return buffer is full.
INSTALLSTATE_INVALIDARG
 An invalid parameter was passed to the function.
INSTALLSTATE_UNKNOWN
 An unrecognized product or feature was specified.
INSTALLSTATE_BROKEN
 The feature is broken.
INSTALLSTATE_ADVERTISED
 The advertised feature.
INSTALLSTATE_ABSENT
 The feature was uninstalled.
INSTALLSTATE_LOCAL
 The feature was installed on the local drive.
INSTALLSTATE_SOURCE
 The feature must run from the source, CD-ROM, or network.
INSTALLSTATE_DEFAULT
 The feature is installed in the default location: local or source.

[out] piAction

Receives the action taken during the installation session. This parameter must not be null. For return values, see piInstalled.

Return value

The MsiGetFeatureState function returns the following values:

Remarks

See Calling Database Functions From Programs.

If the function fails, you can obtain extended error information by using MsiGetLastErrorRecord.

Note

The msiquery.h header defines MsiGetFeatureState as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
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. Windows Installer on Windows Server 2003 or Windows XP
Target Platform Windows
Header msiquery.h
Library Msi.lib
DLL Msi.dll

See also

Installer Selection Functions

Passing Null as the Argument of Windows Installer Functions