WebSphere Message Broker™ V8.0.0.0 .NET Plugin Node API
FormattedMessage Method (ignoreInserts)
NamespacesIBM.Broker.PluginNBExceptionFormattedMessage(Boolean)
SUMMARY
Formats the exception as a string using the catalog provided in the exception itself.
Declaration Syntax
C#Visual BasicVisual C++F#
public virtual string FormattedMessage(
	bool ignoreInserts
)
Public Overridable Function FormattedMessage ( _
	ignoreInserts As Boolean _
) As String
public:
virtual String^ FormattedMessage(
	bool ignoreInserts
)
abstract FormattedMessage : 
        ignoreInserts:bool -> string 
override FormattedMessage : 
        ignoreInserts:bool -> string 
Parameters
ignoreInserts (Boolean)
If true then inserts from the exception are not added into the formatted message.
Return Value
String containing the formatted message, but null is returned if the message cannot be found in the catalog or the catalog cannot be found.
Remarks
Inserts present in the exception can be added if desired. Inserts that are null are represented by empty strings. Note that any tabs or newlines present in the formatted message are removed before the string is returned.
Exceptions
ExceptionCondition
SecurityExceptionThrown if the registry cannot be accessed.
UnauthorizedAccessExceptionThrown if the catalog entry in the registry cannot be accessed.

Assembly: IBM.Broker.Plugin (Module: IBM.Broker.Plugin) Version: 8.0.0.0