Man Pages

catgets(3) - phpMan catgets(3) - phpMan

Command: man perldoc info search(apropos)  


CATGETS(3)                 Linux Programmer's Manual                CATGETS(3)



NAME
       catgets - get message from a message catalog

SYNOPSIS
       #include <nl_types.h>

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

DESCRIPTION
       catgets()  reads the message message_number, in set set_number, from the message catalog identified by catalog,
       where catalog is a catalog descriptor returned from an earlier call to catopen(3).  The fourth argument message
       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
       application if it is to be saved or modified.  The return string is always terminated with a null byte.

RETURN VALUE
       On  success,  catgets()  returns  a  pointer  to an internal buffer area containing the null-terminated message
       string.  On failure, catgets() returns the value message.

CONFORMING TO
       POSIX.1-2001.

NOTES
       These functions are only available in libc.so.4.4.4c and above.  The Jan 1987 X/Open Portability  Guide  speci-
       fies  a more subtle error return: message is returned if the message catalog specified by catalog is not avail-
       able, while an empty string is returned when the message catalog is available but does not contain  the  speci-
       fied message.  These two possible error returns seem to be discarded in SUSv2 in favor of always returning mes-
       sage.

SEE ALSO
       catopen(3), setlocale(3)

COLOPHON
       This page is part of release 3.22 of the Linux man-pages project.  A description of the project,  and  informa-
       tion about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/.



                                  1998-08-09                        CATGETS(3)