Contents

II3IDExitPath Interface

Overview

Derived From: IDispatch

Interface ID: {F9BD5BFB-42F5-4330-85D7-8B06E2EF224D}

II3IDExitPath exposes the functionality of an exit path defined for a tool, subroutine or initiator. Initiators and subroutines only have 1 exit path. Tool steps can have two or more exit paths. Exit Paths are paths that a step can take as a result of the step's action. Exit paths link steps to other steps. For example, a Condition step has two exit paths: True and False. If the condition evaluated by the Condition step is true, the step will exit along the True exit path. If the condition evaluates to False, the step will exit along the False exit path.

Methods

LinkToStep

Links this exit path to the step specified in the NextStep parameter. This method is used to link one step in a handler to another step.

Properties

Designer	Returns an Interaction Designer interface pointer.
ExitPathType	Returns what type of entity the exit path is coming from. Call II3IDExitPath::SourceTool if the ExitPath is of type Tool. If the ExitPath is for a step, call II3IDExitPath::SourceStep.
IsCustom	Indicates whether or not this exit path was added externally by the tool.
IsException	Returns whether or not the exit path was registered as being an exception (error) path.
Label	Returns the label associated with the exit path. This text is localized.
ReturnValue	Returns the return value that the tool returns to exit through this exit path.
SourceInitiator	Return an initiator object that wraps the initiator used to create this exit path.
SourceStep	Returns a step object that wraps the step for this exit path.
SourceSubroutine	Return a subroutine object that wraps the subroutine used to create this exit path.
SourceTool	Returns a tool object that wraps the tool definition for this exit path.