Open topic with navigation

Parcel Object

InstallShield 2015 » Object Expressions for Advanced UI and Suite/Advanced UI Projects

To create an object expression that checks target systems for information about a package in an Advanced UI or Suite/Advanced UI installation, use the Parcel object. The Parcel object has support for properties such as Eligible, ActionState, and DetectedState.

Syntax

[@Parcel(PackageGUID).ActionState]

[@Parcel(PackageGUID).DetectedState]

[@Parcel(PackageGUID).Eligible]

[@Parcel(PackageGUID).ExitCode]

[@Parcel(PackageGUID).Type]

Parameters

One parameter is available for the Parcel object.

Parameters for the Parcel Object

Parameter

Description

PackageGUID

Specify the GUID of the package.

Properties

The following properties are available for the Parcel object.

Properties for the Parcel Object

Property

Description

ActionState

Retrieves the currently set action state of the package. This value may change, depending on when at run time the property is queried. Valid values are:

• 1—The package will run its install operation.
• 2—The package will run its modify operation.
• 3—The package will run its repair operation.
• 4—The package will run its remove operation.
• 5—No action will be performed for the package.

DetectedState

Retrieves the installed state of the package. Valid values are:

• 0—The package is not installed.
• 1—The package is currently installed.

Eligible

Retrieves a Boolean value that indicates whether the target system meets the requirements that are necessary for the package to be run.

ExitCode

Retrieves the exit code for the package once its scheduled operation has completed. The value of this property is indeterminate before package operations are run.

Name

Retrieves the display name of the package.

Type

Retrieves the type of package. Valid values are:

• 0—Executable package (.exe)
• 1—Windows Installer package (.msi)
• 2—Patch package (.msp)
• 3—InstallScript package (.hdr)
• 5—Sideloading app package (.appx)
• 6—Web Deploy package (.zip)

Examples

The following examples demonstrate use of the Parcel object in object expressions.

Sample Parcel Object Expressions

Expression

Description

[@Parcel(0F283EC0-E9D1-4D18-801D-0014F6CA96DF).DetectedState]

Determine whether the referenced package is installed.

[@Parcel(0F283EC0-E9D1-4D18-801D-0014F6CA96DF).ExitCode]

Obtain the exit code for the package once its scheduled operation has completed.

See Also

Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time

Writing Object Expressions in Advanced UI and Suite/Advanced UI Projects to Search Target Systems

InstallShield 2015 Help Library

June 2015

 Copyright Information | Contact Us