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  de‐
17       scriptor returned from an earlier call to catopen(3).  The fourth argu‐
18       ment, message, points to a default message string  which  will  be  re‐
19       turned  by catgets() if the identified message catalog is not currently
20       available.  The message-text is contained in an  internal  buffer  area
21       and  should  be copied by the application if it is to be saved or modi‐
22       fied.  The return string is always terminated with a null byte ('\0').
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() re‐
27       turns the value message.
28

ATTRIBUTES

30       For an  explanation  of  the  terms  used  in  this  section,  see  at‐
31       tributes(7).
32
33       ┌────────────────────────────────────────────┬───────────────┬─────────┐
34       │Interface                                   │ Attribute     │ Value   │
35       ├────────────────────────────────────────────┼───────────────┼─────────┤
36       │catgets()                                   │ Thread safety │ MT-Safe │
37       └────────────────────────────────────────────┴───────────────┴─────────┘
38

CONFORMING TO

40       POSIX.1-2001, POSIX.1-2008.
41

NOTES

43       The  catgets()  function is available only in libc.so.4.4.4c and above.
44       The Jan 1987 X/Open Portability Guide specifies a more subtle error re‐
45       turn:  message  is returned if the message catalog specified by catalog
46       is not available, while an empty string is returned  when  the  message
47       catalog is available but does not contain the specified message.  These
48       two possible error returns seem to be discarded in SUSv2  in  favor  of
49       always returning message.
50

SEE ALSO

52       catopen(3), setlocale(3)
53

COLOPHON

55       This  page  is  part of release 5.12 of the Linux man-pages project.  A
56       description of the project, information about reporting bugs,  and  the
57       latest     version     of     this    page,    can    be    found    at
58       https://www.kernel.org/doc/man-pages/.
59
60
61
62                                  2021-03-22                        CATGETS(3)
Impressum