Generates a message from a set of predefined messages in a
message file.
Syntax
public final static String generateMsg(int traceLevel, int msgNum,
int msgType, int isGlobal, int argCount, Vector msgParams);
public final static String generateMsg(int msgNum, int msgType,
int isGlobal, int argCount, Vector msgParams);
Parameters
- traceLevel
- specifies the trace level at which to generate the message.
When this parameter is omitted, the method generates the message
regardless of the trace level. The message is generated only if the
traceLevel value is equal to or less than the current trace
level of the connector.
- msgNum
- specifies the message number (identifier) in the message
file.
- msgType
- is one of the following message types:
JavaConnectorUtil.XRD_WARNING
JavaConnectorUtil.XRD_ERROR
JavaConnectorUtil.XRD_FATAL
JavaConnectorUtil.XRD_INFO
JavaConnectorUtil.XRD_TRACE
- isGlobal
- is the
CONNECTOR_MESSAGE_FILE message-file constant defined in
the
CWConnectorLogAndTrace class to indicate that the message
file is the connector message
file.
- argCount
- is an integer that specifies the number of parameters within
the message text. To determine the number, refer to the message in
the message file.
- msgParams
- is a list of parameters for the message text.
Return values
A String containing the generated message, or
null if the trace level is greater than the trace level of
the connector.
Notes
The generateMsg() method provides two forms:
- Use the first form of the method (where traceLevel is
the first parameter) for tracing messages. For the message to be
generated, the trace level must
be less than or equal to the trace level of the connector. You then
use the traceWrite() method to send the trace message to
the log destination.
- Use the second form of the signature (where msgNum is
the first parameter) for
logging. You then use the logMsg() method to send the log
message to the log destination.
