- Contents
DesignerCOM API
II3IDExitPaths::Add Method
Synopsis
Adds an exit path to a tool. This should only be performed on tools that have NOT been committed with the II3IDTool::Commit method or on a step's exit paths collection.
IDL Function Prototype
HRESULT Add(
[in] BSTR PathLabel,
[in] long nReturnCode,
[in] VARIANT_BOOL bShowAsException,
[in, optional, defaultvalue(-1)] long Index,
[out, retval] II3IDExitPath ** TheExitPath
);
C/C++ Syntax
HRESULT Add(BSTR PathLabel, long nReturnCode, VARIANT_BOOL bShowAsException, long Index, II3IDExitPath ** TheExitPath);
Parameters
- PathLabel
-
The name you want to assign to this exit path.
- nReturnCode
-
The return code generated when this exit path is taken.
- bShowAsException
-
Specify True to show this exit path as an exception.
- Index
-
An index number can be optionally supplied. The default value is -1.
- TheExitPath
-
The return value is an II3IDExitPath object.