Get Message with Parameter

Retrieves a message from the collaboration message file.

Inputs

Collaboration
The current collaboration object.
ID
An integer that specifies the message number of a message in the collaboration's message file. The message file is indexed by message number.
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}.

Output

Returns a String object that contains the text for the message identified by the ID and Parameters inputs.

Notes

The Get Message with Parameter function block takes a message number and an array of message-parameter values. It retrieves the associated message from the collaboration message file, replaces its message parameters with the objects in the parameter array, and returns the resulting message as a String object.

Related information

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

Copyright IBM Corp. 2004, 2005