NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ATTRIBUTES | STANDARDS | HISTORY | SEE ALSO | COLOPHON |
|
|
catgets(3) Library Functions Manual catgets(3)
catgets - get message from a message catalog
Standard C library (libc, -lc)
#include <nl_types.h> char *catgets(nl_catd catalog, int set_number, int message_number, const char *message);
catgets() reads the message message_number, in set set_number, from the message catalog identified by catalog, where catalog is a catalog descriptor returned from an earlier call to catopen(3). The fourth argument, message, points to a default message string which will be returned by catgets() if the identified message catalog is not currently available. The message-text is contained in an internal buffer area and should be copied by the application if it is to be saved or modified. The return string is always terminated with a null byte ('\0').
On success, catgets() returns a pointer to an internal buffer area containing the null-terminated message string. On failure, catgets() returns the value message.
For an explanation of the terms used in this section, see attributes(7). ┌─────────────────────────────────────┬───────────────┬─────────┐ │ Interface │ Attribute │ Value │ ├─────────────────────────────────────┼───────────────┼─────────┤ │ catgets() │ Thread safety │ MT-Safe │ └─────────────────────────────────────┴───────────────┴─────────┘
POSIX.1-2008.
POSIX.1-2001. The catgets() function is available only in libc.so.4.4.4c and above. The Jan 1987 X/Open Portability Guide specifies a more subtle error return: message is returned if the message catalog specified by catalog is not available, while an empty string is returned when the message catalog is available but does not contain the specified message. These two possible error returns seem to be discarded in SUSv2 in favor of always returning message.
catopen(3), setlocale(3)
This page is part of the man-pages (Linux kernel and C library
user-space interface documentation) project. Information about
the project can be found at
⟨https://www.kernel.org/doc/man-pages/⟩. If you have a bug report
for this manual page, see
⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
This page was obtained from the tarball man-pages-6.9.1.tar.gz
fetched from
⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
2024-06-26. If you discover any rendering problems in this HTML
version of the page, or you believe there is a better or more up-
to-date source for the page, or you have corrections or
improvements to the information in this COLOPHON (which is not
part of the original manual page), send a mail to
man-pages@man7.org
Linux man-pages 6.9.1 2024-06-15 catgets(3)
Pages that refer to this page: catopen(3)