1 .\" Copyright 1993 Mitchum DSouza <m.dsouza@mrc-applied-psychology.cambridge.ac.uk>
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one.
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date. The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein. The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" Updated, aeb, 980809
24 .TH CATGETS 3 1998-08-09 "" "Linux Programmer's Manual"
26 catgets \- get message from a message catalog
29 .B #include <nl_types.h>
31 .BI "char *catgets(nl_catd " catalog ", int " set_number \
32 ", int " message_number ,
33 .BI " const char *" message );
41 from the message catalog identified by
45 is a catalog descriptor returned from an earlier call to
49 points to a default message string which will be returned by
51 if the identified message catalog is not currently available.
53 message-text is contained in an internal buffer area and should be copied by
54 the application if it is to be saved or modified.
56 always terminated with a null byte.
61 returns a pointer to an internal buffer area
62 containing the null-terminated message string.
70 These functions are only available in libc.so.4.4.4c and above.
71 The Jan 1987 X/Open Portability Guide specifies a more subtle
74 is returned if the message catalog specified by
76 is not available, while an empty string is returned
77 when the message catalog is available but does not contain
78 the specified message.
79 These two possible error returns seem to be discarded in SUSv2
80 in favor of always returning