MsiQueryComponentStateA function (msi.h)
The MsiQueryComponentState function returns the installed state for a component. This function can query for a component of an instance of a product that is installed under user accounts other than the current user provided the product is not advertised under the per-user-unmanaged context for a user account other than the current user. The calling process must have administrative privileges to get information for a product installed for a user other than the current user.
Syntax
UINT MsiQueryComponentStateA(
[in] LPCSTR szProductCode,
[in] LPCSTR szUserSid,
[in] MSIINSTALLCONTEXT dwContext,
[in] LPCSTR szComponentCode,
[out] INSTALLSTATE *pdwState
);
Parameters
[in] szProductCode
Specifies the ProductCode GUID for the product that contains the component.
[in] 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, null specifies the current user.
[in] dwContext
The installation context of the product instance being queried.
[in] szComponentCode
Specifies the component being queried. Component code GUID of the component as found in the ComponentID column of the Component table.
[out] pdwState
Installation state of the component for the specified product instance. This parameter can return one of the following or null values.
| Value | Meaning |
|---|---|
|
The component is installed locally. |
|
The component is installed to run from the source. |
Return value
The MsiQueryComponentState function returns the following values.
| Value | Meaning |
|---|---|
|
The calling process must have administrative privileges to get information for a product installed for a user other than the current user. |
|
The configuration data is corrupt. |
|
An invalid parameter was passed to the function. |
|
The function completed successfully. |
|
The component ID does not identify a known component. |
|
The product code does not identify a known product. |
|
Failures that cannot be ascribed to any Windows error code. |
|
Buffer too small to get the user SID. |
For more information, see Displayed Error Messages.
Remarks
Note
The msi.h header defines MsiQueryComponentState as an alias which 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 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. 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 |