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

CONFORMING TO

31       POSIX.1-2001.
32

NOTES

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

COLOPHON

46       This  page  is  part of release 3.53 of the Linux man-pages project.  A
47       description of the project, and information about reporting  bugs,  can
48       be found at http://www.kernel.org/doc/man-pages/.
49
50
51
52                                  2013-06-21                        CATGETS(3)