gettxt(3)gettxt(3)NAMEgettxt - Retrieves a text string from a message catalog
SYNOPSIS
#include <unistd.h>
char *gettxt(
const char *msgid,
const char *dflt_str );
LIBRARY
Standard C Library (libc)
PARAMETERS
Specifies the message identification string. The format of this string
is discussed in more detail below. Specifies the default string to use
if the identified string is not found.
DESCRIPTION
A message catalog contains text strings that can be accessed by pro‐
grams. Message catalogs are created using the gencat and mkcatdefs
commands. The gettxt() function searches a message catalog for a speci‐
fied text string. If the text string is available, it is returned. If
attempts to retrieve the text string do not succeed, the specified
default text string is used.
You can request that messages be displayed in a specific language by
setting environment variables. Likewise, you can also change the lan‐
guage in which the messages are displayed by invoking the setlocale()
function with the appropriate arguments.
To retrieve a text string, the program must use the following format
when specifying the msgid parameter:
msgfilename:msgnumber
The arguments are defined as follows: Specifies the message catalog
that contains the localized version of the text string. Characters in
the text string can be any set of characters excluding null (\0), the
ASCII symbols for slash (/), and the colon (:). Specified as a posi‐
tive number only, this argument denotes the index of the text string in
the message catalog.
If the text string specified does not exist in the catalog associated
with the locale setting, or if the message number exceeds the bounds of
the catalog, attempts are made to retrieve this message from the cata‐
log for the C locale. Should the second attempt be unsuccessful, the
text string specified by the dflt_str is used.
RESTRICTIONS
On this operating system, the gettxt() function parses the directory
locale as described on the catopen(3) and catgets(3) reference pages.
RETURN VALUES
The string Message not found!!\n is returned if the value for the msg‐
filename argument is invalid, a catalog number has not been specified,
the value for msgnumber is not a positive number, or a message could
not be retrieved and the dflt_str parameter was not specified.
ERRORS
No errors are defined for this function.
SEE ALSO
Commands: gencat(1), mkcatdefs(1)
Functions: catgets(3), catopen(3)gettxt(3)
