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. Open link

dcget_text()

Get message text by defining locale domain and category.

Syntax

dcget_text(domain_name, message_ID, category)

Parameters

Parameter

Definition

domain_name

file name for message catalog Use only characters that are permitted in file names.

message_ID

text string that identifies a message

category

locale category Name of the locale category also determines the name of the directory that contains the domain file. Valid values 
CTYPE, MESSAGES, TIME, and CODECVT

Description

The dcget_text() function returns a message that has a text string as the message ID. The dcget_text() and dget_text() functions serve the same purpose, but dcget_text() requires that you specify domain_name and category. These parameters 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 dcget_text() function returns message_ID when it cannot find a message that matches the specified message_ID, domain_name and category. It also returns message_ID when the current locale is the same as the CTYPE locale.

Note

This function provides support for internationalized PSL scripts. For more information about internationalization, see PATROL Script Language Reference Manual Volume 1 --PSL Essentials.

Example

The following example demonstrates the dcget_text() function.

function display_dcget_text(domain, msg_id, category)
{
ret = dcget_text(domain, msg_id, category);
printf("Message text = %s", ret);
}
display_dcget_text("test_msg", "hello", "CODECVT");
Was this page helpful? Yes No Submitting... Thank you

Comments