Export (0) Print
Expand All
Expand Minimize

MsiSetMode function

The MsiSetMode function sets an internal engine Boolean state.

Syntax


UINT MsiSetMode(
  _In_  MSIHANDLE hInstall,
  _In_  unsigned int iRunMode,
  _In_  BOOL fState
);

Parameters

hInstall [in]

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

iRunMode [in]

Specifies the run mode. This parameter must be one of the following values. While there are many values for this parameter, as described in MsiGetMode, only one of the following values can be set.

ValueMeaning
MSIRUNMODE_REBOOTATEND

A reboot is necessary after a successful installation.

MSIRUNMODE_REBOOTNOW

A reboot is necessary to continue installation.

 

fState [in]

Specifies the state to set to TRUE or FALSE.

Return value

ERROR_ACCESS_DENIED

Access was denied.

ERROR_INVALID_HANDLE

An invalid or inactive handle was supplied.

ERROR_SUCCESS

The function succeeded.

Requirements

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 on Windows Server 2003 or Windows XP

Header

Msiquery.h

Library

Msi.lib

DLL

Msi.dll

See also

Installer State Access Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft