catgets(3)

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       ('\0').
24

RETURN VALUE

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

ATTRIBUTES

31       For   an   explanation   of   the  terms  used  in  this  section,  see
32       attributes(7).
33
34       ┌──────────┬───────────────┬─────────┐
35       │Interface │ Attribute     │ Value   │
36       ├──────────┼───────────────┼─────────┤
37       │catgets() │ Thread safety │ MT-Safe │
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
45       return: 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

COLOPHON

55       This page is part of release 4.16 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                                  2015-08-08                        CATGETS(3)