CATGETS(3)

CATGETS(3)

catclose Home Page Subroutines Index catopen


NAME
       catgets - get message from a message catalog

SYNOPSIS
       #include <<features.h>>
       #include <<nl_types.h>>

       char *catgets(catalog, set_number, message_number, message)
       nl_catd catalog;
       int set_number;
       int message_number;
       char *message;

DESCRIPTION
       catgets()   reads   the  message  message_number,  in  set
       set_number, from the message catalog identified  by  cata-
       log,  where  catalog is a catalog descriptor returned from
       an earlier call to catopen(3).  The fourth  argument  mes-
       sage  points  to  a  default  message string which will be
       returned by catgets() if the identified message catalog is
       not  currently available. The message-text is contained in
       an internal buffer area and should be copied by the appli-
       cation if it is to be saved or modified. The return string
       is always terminated with a null byte.

RETURN VALUES
       On success, catgets() returns a  pointer  to  an  internal
       buffer area containing the null-terminated message string.
       On failure, catgets() returns  the  value  message  if  it
       fails  because the message catalog specified by catalog is
       not available. On the other  hand,  catgets()  returns  an
       empty  string if the message catalog is available but does
       not contain the specified message.

NOTES
       These functions are only available in  libc.so.4.4.4c  and
       above.   The  two  possible  error returns seem to be dis-
       carded in XPG4.2 in favour of always returning message.

SEE ALSO
       catopen(3) setlocale(3) 

catclose Home Page Subroutines Index catopen