GetSetItemInfo method

Applies to

Description

Use this method to get the rules for how the set definition is defined. The argument SetItemNo must have a value between 1 and the number of Set Items in the set definition.

The method’s return value is 0 on success, otherwise non-zero.

Returns values for the arguments FormName, Level, From, To, Sequence, and BreakItem as defined in the set definition for the set item SetItemNo. For more information, look at the Set definition dialog in the Manager module.

Syntax

[ReturnValue =] Object.GetSetItemInfo(SetItemNo, FormName, Level, From, To, Sequence, BreakItem)

Part

Data type

Description

Object

Object

An object expression that evaluates to an object in the Applies To list.

SetItemNo

Integer

Number of the item in the set definition to get the set logic for.

FormName

String (ByRef)

FormName is the name of the SetItemNo form definition in the set definition.

Level

Integer (ByRef)

Level indicate the hierarchy of the form definition in the set definition.

From

Integer (ByRef)

From is the minimum number of forms in the set.

To

Integer (ByRef)

To is the maximum number of forms in the set.

Sequence

Integer (ByRef)

Sequence is 1 if the set logic form must be in a certain sequence. Otherwise zero

BreakItem

String (ByRef)

If there is a set break item, BreakItem contains the set break text. Otherwise BreakItem is empty.

Settings

1 <= SetItemNo <= NoOfFormDefs

Return value

Data type: Integer – the return value is 0 if it succeeded, otherwise non-zero. See Event return value constants.

Remarks

Classic method

GetSetItemInfo