gettxt(3c) [sunos man page]
gettxt(3C) Standard C Library Functions gettxt(3C) NAME
gettxt - retrieve a text string SYNOPSIS
#include <nl_types.h> char *gettxt(const char *msgid, const char *dflt_str); DESCRIPTION
The gettxt() function retrieves a text string from a message file. The arguments to the function are a message identification msgid and a default string dflt_str to be used if the retrieval fails. The text strings are in files created by the mkmsgs utility (see mkmsgs(1)) and installed in directories in /usr/lib/locale/locale/LC_MES- SAGES. The directory locale can be viewed as the language in which the text strings are written. The user can request that messages be displayed in a specific language by setting the environment variable LC_MESSAGES. If LC_MESSAGES is not set, the environment variable LANG will be used. If LANG is not set, the files containing the strings are in /usr/lib/locale/C/LC_MESSAGES/*. The user can also change the language in which the messages are displayed by invoking the setlocale(3C) function with the appropriate argu- ments. If gettxt() fails to retrieve a message in a specific language it will try to retrieve the same message in U.S. English. On failure, the processing depends on what the second argument dflt_str points to. A pointer to the second argument is returned if the second argument is not the null string. If dflt_str points to the null string, a pointer to the U.S. English text string "Message not found!! " is returned. The following depicts the acceptable syntax of msgid for a call to gettxt(). <msgid> = <msgfilename>:<msgnumber> The first field is used to indicate the file that contains the text strings and must be limited to 14 characters. These characters must be selected from the set of all character values excluding (null) and the ASCII code for / (slash) and : (colon). The names of message files must be the same as the names of files created by mkmsgs and installed in /usr/lib/locale/locale/LC_MESSAGES/*. The numeric field indicates the sequence number of the string in the file. The strings are numbered from 1 to n where n is the number of strings in the file. RETURN VALUES
Upon failure to pass either the correct msgid or a valid message number to gettxt(), a pointer to the text string "Message not found!! " is returned. USAGE
It is recommended that gettext(3C) be used in place of this function. EXAMPLES
Example 1: Example of gettxt() function. In the following example, gettxt("UX:10", "hello world ") gettxt("UX:10", "") UX is the name of the file that contains the messages and 10 is the message number. FILES
/usr/lib/locale/C/LC_MESSAGES/* contains default message files created by mkmsgs /usr/lib/locale/locale/LC_MESSAGES/* contains message files for different languages created by mkmsgs ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |MT-Level |Safe with exceptions | +-----------------------------+-----------------------------+ SEE ALSO
exstr(1), mkmsgs(1), srchtxt(1), gettext(3C), fmtmsg(3C), setlocale(3C), attributes(5), environ(5) SunOS 5.10 29 Dec 1996 gettxt(3C)
Check Out this Related Man Page
gettxt(1) User Commands gettxt(1) NAME
gettxt - retrieve a text string from a message database SYNOPSIS
gettxt msgfile : msgnum [dflt_msg] DESCRIPTION
gettxt retrieves a text string from a message file in the directory /usr/lib/locale/locale/LC_MESSAGES . The directory name locale corre- sponds to the language in which the text strings are written; see setlocale(3C). msgfile Name of the file in the directory /usr/lib/locale/locale/LC_MESSAGES to retrieve msgnum from. The name of msgfile can be up to 14 characters in length, but may not contain either (null) or the ASCII code for / (slash) or : (colon). msgnum Sequence number of the string to retrieve from msgfile. The strings in msgfile are numbered sequentially from 1 to n, where n is the number of strings in the file. dflt_msg Default string to be displayed if gettxt fails to retrieve msgnum from msgfile. Nongraphic characters must be represented as alphabetic escape sequences. The text string to be retrieved is in the file msgfile, created by the mkmsgs(1) utility and installed under the directory /usr/lib/locale/locale/LC_MESSAGES . You control which directory is searched by setting the environment variable LC_MESSAGES. If LC_MES- SAGES is not set, the environment variable LANG will be used. If LANG is not set, the files containing the strings are under the directory /usr/lib/locale/C/LC_MESSAGES . If gettxt fails to retrieve a message in the requested language, it will try to retrieve the same message from /usr/lib/locale/C/LC_MES- SAGES/ msgfile. If this also fails, and if dflt_msg is present and non-null, then it will display the value of dflt_msg; if dflt_msg is not present or is null, then it will display the string Message not found!!. EXAMPLES
Example 1: The environment variables LANG and LC_MESSAGES. If the environment variables LANG or LC_MESSAGES have not been set to other than their default values, the following example: example% gettxt UX:10 "hello world " will try to retrieve the 10th message from /usr/lib/locale/C/UX/msgfile. If the retrieval fails, the message "hello world," followed by a newline, will be displayed. ENVIRONMENT VARIABLES
See environ(5) for descriptions of the following environment variables that affect the execution of gettxt: LC_CTYPE and LC_MESSAGES. LC_CTYPE Determines how gettxt handles characters. When LC_CTYPE is set to a valid value, gettxt can display and handle text and filenames containing valid characters for that locale. gettxt can display and handle Extended Unix Code (EUC) characters where any individual character can be 1, 2, or 3 bytes wide. gettxt can also handle EUC characters of 1, 2, or more column widths. In the "C" locale, only characters from ISO 8859-1 are valid. LC_MESSAGES Determines how diagnostic and informative messages are presented. This includes the language and style of the mes- sages, and the correct form of affirmative and negative responses. In the "C" locale, the messages are presented in the default form found in the program itself (in most cases, U.S. English). FILES
/usr/lib/locale/C/LC_MESSAGES/* default message files created by mkmsgs(1) /usr/lib/locale/locale/LC_MESSAGES/* message files for different languages created by mkmsgs(1) ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWloc | +-----------------------------+-----------------------------+ |CSI |Enabled | +-----------------------------+-----------------------------+ SEE ALSO
exstr(1), mkmsgs(1), srchtxt(1), gettxt(3C), setlocale(3C), attributes(5), environ(5) SunOS 5.10 20 Dec 1996 gettxt(1)