Element: messagefile.text ( )

Type

string

Description

A function to retrieve text from the message file. Message files are segmented into sets, and messages within each set.

For multi-language message files, the text retrieved will be that for the current language (see messagefile.current_language).

This function takes at least 2 parameters, the set number and message number.

If the set or message does not exist, an empty string is returned.

The text can be in the form of a C printf format statement in which case additional parameter values can be specified to satisfy the format.

Parameters

<messagefile>.text(<num1>,<num2> {,<values>} )

Examples

# Declare the message file
messagefile mf = '$MYFILES/messages.mes'
# Retrieve the text of set 2, message 7
string s = mf.text(2,7)
# Retrieve formatted text
string s = mf.text(2,8,'entity',100)

If the message text of set 2 message 8 was

'Maximum no of %s files is %d'

The above will return: 'Maximum no of entity files is 100'