To String

Formats exception information, including the exception type and text, to a String.

Inputs

Collaboration exception
The collaboration exception (a CollaborationException object).

Output

Returns a String that contains the exception type and text.

Notes

The To String function block formats the exception information for the current exception as follows:

exceptionType: messageText

In the line above, exceptionType is the exception object's exception type and messageText is its exception text.

Note:
You can use the Get Message function block to retrieve only the exception text from the current exception.

Related Information

This function block is based on the collaborationException.toString() method. For more information, see toString().

Copyright IBM Corp. 2004