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
mkmsgs(1) User Commands mkmsgs(1) NAME
mkmsgs - create message files for use by gettxt SYNOPSIS
mkmsgs [-o] [-i locale] inputstrings msgfile DESCRIPTION
The mkmsgs utility is used to create a file of text strings that can be accessed using the text retrieval tools (see gettxt(1), srchtxt(1), exstr(1), and gettxt(3C)). It will take as input a file of text strings for a particular geographic locale (see setlocale(3C)) and create a file of text strings in a format that can be retrieved by both gettxt(1) and gettxt(3C). By using the -i option, you can install the cre- ated file under the /usr/lib/locale/locale/LC_MESSAGES directory (locale corresponds to the language in which the text strings are writ- ten). inputstrings is the name of the file that contains the original text strings. msgfile is the name of the output file where mkmsgs writes the strings in a format that is readable by gettxt(1) and gettxt(3C). 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). The input file contains a set of text strings for the particular geographic locale. Text strings are separated by a newline character. Non- graphic characters must be represented as alphabetic escape sequences. Messages are transformed and copied sequentially from inputstrings to msgfile. To generate an empty message in msgfile, leave an empty line at the correct place in inputstrings. Strings can be changed simply by editing the file inputstrings. New strings must be added only at the end of the file; then a new msgfile file must be created and installed in the correct place. If this procedure is not followed, the retrieval function will retrieve the wrong string and software compatibility will be broken. OPTIONS
The following options are supported: -o Overwrite msgfile, if it exists. -i locale Install msgfile in the /usr/lib/locale/locale/LC_MESSAGES directory. Only someone who is super user or a member of group bin can create or overwrite files in this directory. Directories under /usr/lib/locale will be created if they do not exist. EXAMPLES
Example 1: Using the mkmsgs command. The following example shows an input message source file C.str: File %s: cannot be opened %s: Bad directory . . . write error . . Example 2: Using Input Strings From C.str to Create Text Strings in a File The following command uses the input strings from C.str to create text strings in the appropriate format in the file UX in the current directory: example% mkmsgs C.str UX Example 3: Using Input Strings From FR.str to Create Text Strings in a File The following command uses the input strings from FR.str to create text strings in the appropriate format in the file UX in the directory /usr/lib/locale/fr/LC_MESSAGES: example% mkmsgs -i fr FR.str UX These text strings would be accessed if you had set the environment variable LC_MESSAGES=fr and then invoked one of the text retrieval tools listed at the beginning of the DESCRIPTION section. FILES
/usr/lib/locale/locale/LC_MESSAGES/* message files created by mkmsgs ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |Availability |SUNWloc | +-----------------------------+-----------------------------+ SEE ALSO
exstr(1), gettxt(1), srchtxt(1), gettxt(3C), setlocale(3C), attributes(5) SunOS 5.10 26 Jul 1994 mkmsgs(1)