MSI.GetMode

boolean MSI.GetMode ( 

number hInstall,

number RunMode )

Description

Calls the MsiGetMode function that is used to determine whether the installer is currently running in a specified mode, as listed in the table. The function returns a Boolean value of True or False, indicating whether the specific property passed into the function is currently set (True) or not set (False).

Parameters

 

hInstall

(number) The handle to the installation.

Note:  _hInstall is the default for this parameter. See Global Variables for more information.

RunMode

(number) The run mode to test for. One of the following:

CONSTANT

VALUE

DESCRIPTION

MSIRUNMODE_ADMIN

0

The administrative mode is installing, or the product is installing.

MSIRUNMODE_ADVERTISE

1

The advertisements are installing or the product is installing or updating.

MSIRUNMODE_MAINTENANCE

2

An existing installation is being modified or there is a new installation.

MSIRUNMODE_ROLLBACKENABLED

3

Rollback is enabled.

MSIRUNMODE_LOGENABLED

4

The log file is active. It was enabled prior to the installation session.

MSIRUNMODE_OPERATIONS

5

Execute operations are spooling or they are in the determination phase.

MSIRUNMODE_REBOOTATEND

6

A reboot is necessary after a successful installation (settable).

MSIRUNMODE_REBOOTNOW

7

A reboot is necessary to continue the installation (settable).

MSIRUNMODE_CABINET

8

Files from cabinets and Media table files are installing.

MSIRUNMODE_SOURCESHORTNAMES

 9

 The source LongFileNames is suppressed through the PID_MSISOURCE summary property.

MSIRUNMODE_TARGETSHORTNAMES

10

The target LongFileNames is suppressed through the SHORTFILENAMES property.

MSIRUNMODE_RESERVED11

11

Reserved for future use.

MSIRUNMODE_WINDOWS9X

12

The operating system is Windows 98 or Windows 95.

MSIRUNMODE_ZAWENABLED

13

The operating system supports demand installation.

MSIRUNMODE_RESERVED14

14

Reserved for future use.

MSIRUNMODE_RESERVED15

 15

 Reserved for future use.

MSIRUNMODE_SCHEDULED

16

A custom action called from install script execution.

MSIRUNMODE_ROLLBACK

17

A custom action called from rollback execution script.

MSIRUNMODE_COMMIT

18

A custom action called from commit execution script.

Returns

(boolean)  Returns true if the run mode specified above is currently set. You can use Application.GetLastError to determine whether this action failed, and why.

See also:  Related Actions