getFormattedMessage()

Formats the exception's message into a special format.

Syntax

public String getFormattedMessage();

Parameters

None.

Return values

A String containing the formatted error message, or null if the exception object is initialized with null when it is constructed.

Notes

The message that getFormattedMessage() returns has the following format:

[Type: <MsgType>][MsgID: <msgId>][Mesg: <msg>]

To retrieve the error message embedded in the exception, use the getFormattedMessage() method.

Copyright IBM Corp. 1997, 2004