DlgSelectPackages.GetCategoryProperties

table DlgSelectPackages.GetCategoryProperties (

Description

Gets the properties of a package category within the select package control on the current screen.

Note: This action will only work if called from a screen's events and if the named control is on the current screen. This action is normally used on the Select Packages screen.

Tip: You can also get and set the properties of packages using SetupData.GetPackageProperties and SetupData.SetPackageProperties and get a list of the packages using SetupData.GetPackageList.

Parameters

PackageControlID

(number) The numeric ID of the select packages control whose category properties you want.

CategoryControlID

(number) The numeric ID of the package category whose properties you want.

Returns

(table) A table containing the control properties, indexed by the following categories:

KEY	TYPE	DESCRIPTION
Text	string	The text currently displayed in the category. It can be accessed using tb.Text.
Description	string	The description text of category. It can be accessed using tb.Description.
Enabled	boolean	Whether or not the category is enabled. It can be accessed using tb.Enabled.
Expanded	boolean	Whether or not the category is expanded in the tree view. It can be accessed using tb.Expanded.
State	number	The current state of the category. One of the following states (constant or corresponding value) are returned: CB_UNCHECKED = 1 (the category is currently unchecked) CB_CHECKED = 2 (the category is currently checked) CB_INDETERMINATE = 3 (the category contains subcategories with mixed states) It can be accessed using tb.State.

If the current screen does not contain the control, this action will fail. If this action fails, nil is 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.