NAME    [Toc]    [Back]

       gettxt - Retrieves a text string from a message catalog

SYNOPSIS    [Toc]    [Back]

       #include <unistd.h>

       char *gettxt(
               const char *msgid,
               const char *dflt_str );

LIBRARY    [Toc]    [Back]

       Standard C Library (libc)

PARAMETERS    [Toc]    [Back]

       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    [Toc]    [Back]

       A message  catalog  contains  text  strings  that  can  be
       accessed  by programs.  Message catalogs are created using
       the gencat and mkcatdefs commands. The  gettxt()  function
       searches  a  message  catalog for a specified 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 language 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 positive
       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  catalog  for  the  C
       locale.   Should  the  second attempt be unsuccessful, the
       text string specified by the dflt_str is used.

RESTRICTIONS    [Toc]    [Back]

       On this operating system, the gettxt() function parses the
       directory  locale  as described on the catopen(3) and catgets(3) reference pages.

RETURN VALUES    [Toc]    [Back]

       The string Message not found!!\n is returned if the  value
       for  the msgfilename 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    [Toc]    [Back]

       No errors are defined for this function.

SEE ALSO    [Toc]    [Back]

       Commands: gencat(1), mkcatdefs(1)

       Functions: catgets(3), catopen(3)



                                                        gettxt(3)