Bookshelf v7.5: LookupMessage

Siebel Object Interfaces Reference > Interfaces Reference > Application Methods >

LookupMessage

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

Syntax

TheApplication().LookupMessage (category, key, [param1], [param2],...., [paramN])

Parameter

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.

param1, param2, ..., paramN

Optional parameters used to format the error message if it contains any substitution parameters (%1, %2).

Returns

A string containing the localized message text.

Usage

Useful for retrieving locale specific custom error messages.

Used With

Server Script

Parameter	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.
param1, param2, ..., paramN	Optional parameters used to format the error message if it contains any substitution parameters (%1, %2).

Siebel Object Interfaces Reference
Published: 18 June 2003