1CATGETS(3)                 Linux Programmer's Manual                CATGETS(3)
2
3
4

NAME

6       catgets - get message from a message catalog
7

SYNOPSIS

9       #include <nl_types.h>
10
11       char *catgets(nl_catd catalog, int set_number, int message_number,
12                     const char *message);
13

DESCRIPTION

15       catgets() reads the message message_number, in set set_number, from the
16       message catalog identified by  catalog,  where  catalog  is  a  catalog
17       descriptor  returned  from  an  earlier call to catopen(3).  The fourth
18       argument message points to a  default  message  string  which  will  be
19       returned  by  catgets()  if  the identified message catalog is not cur‐
20       rently available.  The message-text is contained in an internal  buffer
21       area  and  should  be copied by the application if it is to be saved or
22       modified.  The return string is always terminated with a null byte.
23

RETURN VALUE

25       On success, catgets() returns a pointer to an internal buffer area con‐
26       taining  the  null-terminated  message  string.   On failure, catgets()
27       returns the value message.
28

CONFORMING TO

30       POSIX.1-2001.
31

NOTES

33       These functions are only available in libc.so.4.4.4c  and  above.   The
34       Jan 1987 X/Open Portability Guide specifies a more subtle error return:
35       message is returned if the message catalog specified by catalog is  not
36       available,  while  an empty string is returned when the message catalog
37       is available but does not contain the  specified  message.   These  two
38       possible error returns seem to be discarded in SUSv2 in favor of always
39       returning message.
40

SEE ALSO

42       catopen(3), setlocale(3)
43

COLOPHON

45       This page is part of release 3.22 of the Linux  man-pages  project.   A
46       description  of  the project, and information about reporting bugs, can
47       be found at http://www.kernel.org/doc/man-pages/.
48
49
50
51                                  1998-08-09                        CATGETS(3)
Impressum