TargetName Function

Syntax

String TargetName(PropertyObject propertyObject, String stepIdOrName, Boolean isExpression = False, Boolean includeStepGroup = False, Number/String stepGroup = -1, Number/String stepGroupToOmit = -1)

Return Value

String

The target name string.

Parameters

propertyObject as PropertyObject

A Sequence or SequenceFile property object.

stepIdOrName as String

A unique step ID or a step name string.

isExpression as Boolean

(Optional) Specifies whether the stepIdOrName is a string expression. Default value is False.

includeStepGroup as Boolean

(Optional) Specifies whether the step group of the target should be included in the target name. Default value is False.

stepGroup as Number/String

(Optional) Specifies the step group of the target. This parameter is ignored when you specify a unique step Id. Default value is -1.

stepGroupToOmit as Number/String

(Optional) Specifies a step group that should not be displayed. If this [includeStepGroup] is True and the target is in the step group specified by this parameter, then the step group is not added to the target name. Default value is -1.