Bookshelf v7.8: LookupMessage Method

Siebel Object Interfaces Reference > Interfaces Reference > Application Methods >

LookupMessage Method

The LookupMessage method returns the translated string for the specified key, in the current language, from the specified category. The optional arguments are used to format the string if it contains any substitution arguments (%1,%2).

Syntax

Application.LookupMessage (category, key, [arg1], [arg2],...., [argN])


Argument	Description
Category	Name of the Message Category object, as defined in Siebel Tools, that is the parent of Key value.
Key	Name of the Message object, as defined in Siebel Tools, whose text contains the value to be investigated.
arg1, arg2, ..., argN	Optional arguments used to format the error message if it contains any substitution arguments (%1, %2).

Returns

A string containing the localized message text.

Usage

Useful for retrieving locale specific custom error messages.

Used With

Server Script

Example

The following eScript example returns the text "Account Title should be entered before Stepping off." To test this under the "User Defined Errors" message category, create a new record with the following text: "%1 should be entered before Stepping Off." The parameter that is substituted in place of %1 is "Account Title", which is present in the message test.

var sVal = TheApplication().LookupMessage("User Defined Errors", "Test", "Account Title");

Siebel Object Interfaces Reference