Product.ComponentState method

Article
03/22/2021

The ComponentState property is the installation state of the component for the instance of this product.

This property calls MsiQueryComponentState, with the ProductCode, UserSid, and Context of the object. The component Id GUID is provided as a parameter.

Syntax

Product.ComponentState(
  ID
)

Parameters

ID: Component code GUID of the component as found in the ComponentID column of the Component table.

Return value

This method does not return a value.

Remarks

If the call succeeds, the property contains the value as a DWORD.

State	Meaning
INSTALLSTATE_LOCAL	The component is installed locally.
INSTALLSTATE_SOURCE	The component is installed to run from the source.

If the call fails, the property contains an error code from MsiQueryComponentState.

Error	Meaning
ERROR_ACCESS_DENIED	The calling process must have administrative privileges to get information 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_COMPONENT	The component ID does not identify a known component.
ERROR_UNKNOWN_PRODUCT	The product code does not identify a known product.
ERROR_FUNCTION_FAILED	An unexpected internal failure.

Requirements

Requirement	Value
Version	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 3.0 or later on Windows Server 2003, Windows XP, and Windows 2000
DLL	Msi.dll
IID	IID_IProduct is defined as 000C10A0-0000-0000-C000-000000000046