SetupData.GetPackageProperties

table SetupData.GetPackageProperties ( 

string PackageName )

Description

Returns a table containing the properties of a given package.

Tip: If using the Select Packages screen, there are also DlgSelectPackages actions to manipulate the properties of the categories containing the packages.

Parameters

PackageName

(string) The name of the package whose properties you want.

Returns

(table) A table containing the properties of the given package, indexed by the following keys:

KEY

TYPE

DESCRIPTION

AdditionalDiskSpace

number

The value in KB that is added to the package size calculation. This value is defined at design time in the Additional disk space field of the package's properties dialog. You can access this table item using tb.AdditionalDiskSpace.

DisplayName

string

The current localized display name of the package according to the current setup language. You can access this table item using tb.DisplayName.

Description

string

The current localized description of the package according to the current setup language. You can access this table item using tb.Description.

Install

boolean

Whether or not the package is currently set to be installed. If true is returned, the package is currently set to be installed. A false value means it is currently not set to be installed. You can access this table item using tb.Install.

Enabled

boolean

Whether or not the current package will be enabled if shown on the Select Packages screen. A value of true means it will be shown, and false means it will not. You can access this table item using tb.Enabled.

If this action fails, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the action editor, you can use this field to specify a variable that the return value will be stored in.

See also:  Related Actions