Prepares a collaboration exception to raise to the next higher level of
execution. This function block provides another way to create a new
exception object that contains a specified message in a message file.
All parameter values are placed in an array of Objects.
- Note:
- This function block is located in the General\APIs\Collaboration
Template\Exception folder.
- Collaboration
- The current collaboration object.
- Exception type
- A String that specifies the exception type.
- messageNum
- An integer that specifies the number for the message associated with the
exception object.
- Parameters
- An array of message-parameter values. Each is sequentially resolved
to a parameter in the message text. Within the message (in the
collaboration message file), message parameters are indicated by integers
enclosed by braces; for example, {1}.
This function block is useful in raising an exception object that:
- The collaboration has previously handled. For example, a scenario
might get an exception, assign it to a variable, and do some other
work.
- Has more than five message parameters. Whereas the other Raise
Collaboration Exception function blocks can handle no more than five
parameters, the parameter array can contain any number of parameters.
For more information about using the Raise Collaboration Exception function
blocks, see Raise Collaboration Exception.
This function block is based on the
BaseCollaboration.raiseException() method. For more information,
see raiseException().
