MsiConfigureProduct Function

Windows Installer

MsiConfigureProduct Function

The MsiConfigureProduct function installs or uninstalls a product.

Syntax

C++UINT MsiConfigureProduct(
  __in  LPCTSTR szProduct,
  __in  int iInstallLevel,
  __in  INSTALLSTATE eInstallState
);

Parameters

szProduct [in]

Specifies the product code for the product to be configured.

iInstallLevel [in]

Specifies how much of the product should be installed when installing the product to its default state. The iInstallLevel parameter is ignored, and all features are installed, if the eInstallState parameter is set to any other value than INSTALLSTATE_DEFAULT.

This parameter can be one of the following values.

Value Meaning
INSTALLLEVEL_DEFAULT

The authored default features are installed.

INSTALLLEVEL_MINIMUM

Only the required features are installed. You can specify a value between INSTALLLEVEL_MINIMUM and INSTALLLEVEL_MAXIMUM to install a subset of available features.

INSTALLLEVEL_MAXIMUM

All features are installed. You can specify a value between INSTALLLEVEL_MINIMUM and INSTALLLEVEL_MAXIMUM to install a subset of available features.

 

eInstallState [in]

Specifies the installation state for the product. This parameter can be one of the following values.

Value Meaning
INSTALLSTATE_LOCAL

The product is to be installed with all features installed locally.

INSTALLSTATE_ABSENT

The product is uninstalled.

INSTALLSTATE_SOURCE

The product is to be installed with all features installed to run from source.

INSTALLSTATE_DEFAULT

The product is to be installed with all features installed to the default states specified in the Feature Table.

INSTALLSTATE_ADVERTISED

The product is advertised.

 

Return Value

Value Meaning
ERROR_INVALID_PARAMETER

An invalid parameter is passed to the function.

ERROR_SUCCESS

The function succeeds.

An error that relates to an action

For more information, see Error Codes.

Initialization Error

An error that relates to initialization.

 

Remarks

The MsiConfigureProduct function displays the user interface (UI) using the current settings. User interface settings can be changed by using MsiSetInternalUI, MsiSetExternalUI or MsiSetExternalUIRecord.

The iInstallLevel parameter is ignored, and all features of the product are installed, if the eInstallState parameter is set to any other value than INSTALLSTATE_DEFAULT. To control the installation of individual features when the eInstallState parameter is not set to INSTALLSTATE_DEFAULT, use MsiConfigureFeature.

Requirements

VersionWindows Installer 5.0 on 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, Windows XP, and Windows 2000. See the Windows Installer Run-Time Requirements for information about the minimum Windows service pack that is required by a Windows Installer version.
HeaderMsi.h
LibraryMsi.lib
DLLMsi.dll
Unicode and ANSI namesMsiConfigureProductW (Unicode) and MsiConfigureProductA (ANSI)

See Also

Multiple-Package Installations

Send comments about this topic to Microsoft

Build date: 8/13/2009

© 2009 Microsoft Corporation. All rights reserved.