Important This documentation space contains information about PATROL Agents when deployed in a TrueSight Operations Management environment. If you are a BMC Helix Operations Management user, see PATROL Agent 22.1 for BMC Helix Operations Management.

get_text()


Get message text

Syntax

get_text(message_ID)

Parameter

Parameter

Definition

message_ID

text string that identifies a message

Description

The get_text() function returns a message that has a text string as the message ID. The dget_text() and dcget_text() functions serve the same purpose, but you cannot use get_text() to specify the domain name or locale category. For locale category, get_text() uses the MESSAGES category as the current locale. For domain, get_text uses the domain of the current locale. You can set this domain by using the text_domain() function. See text_domain()

The domain_name and category determine the name of the catalog file and the directory path according to the following format: 

PATROL_HOME/lib/nls/locale/ locale_name/ML_ category/ domain_name.bo 

The get_text() function returns message_ID when it cannot find a message that matches the relevant message_ID, domain_name and category. It also returns message_ID when the current locale is the same as the CTYPE category.

This function provides support for internationalized PSL scripts. For more information about internationalization, see Internationalized-PSL-Scripts.

Example

The following is an example of the get_text() function.

function display_get_text(msg)
{
ret = get_text(msg);
printf("Message = %s \n", ret);
}
display_get_text("hello");