NAME    [Toc]    [Back]

     catgets - retrieve string from message catalog

LIBRARY    [Toc]    [Back]

     Standard C Library (libc, -lc)

SYNOPSIS    [Toc]    [Back]

     #include <nl_types.h>

     char *
     catgets(nl_catd catd, int set_id, int msg_id, const char *s);

DESCRIPTION    [Toc]    [Back]

     The catgets() function attempts to retrieve message msg_id of set set_id
     from the message catalog referenced by the descriptor catd.  The argument
     s points to a default message which is returned if the function is unable
     to retrieve the specified message.

RETURN VALUES    [Toc]    [Back]

     If the specified message was retrieved successfully, catgets() returns a
     pointer to an internal buffer containing the message string; otherwise it
     returns s.

ERRORS    [Toc]    [Back]

     The catgets() function will fail if:

     [EBADF]            The catd argument is not a valid message catalog
                        descriptor open for reading.

     [EINTR]            The operation was interrupted by a signal.

     [ENOMSG]           The message identified by set_id and msg_id is not in
                        the message catalog.

SEE ALSO    [Toc]    [Back]

     catclose(3), catopen(3)

STANDARDS    [Toc]    [Back]

     The catgets() function conforms to X/Open Portability Guide Issue 4.2
     (``XPG4.2'').

BSD                            February 8, 1998                            BSD