catgets(3C)
NAME
catgets − read a program message
SYNOPSIS
#include <nl_types.h>
char ∗catgets(nl_catd catd, int set_num, int msg_num, const char ∗s);
DESCRIPTION
catgets() attempts to read message msg_num, in set set_num, from the message catalog identified by catd. catd is a catalog descriptor returned from an earlier call to catopen(). s points to a default message string which will be returned by catgets() if the identified message catalog is not currently available.
RETURN VALUES
If the identified message is retrieved successfully, catgets() returns a pointer to an internal buffer area containing the null terminated message string. If the call is unsuccessful for any reason, catgets() returns a pointer to s and errno may be set to indicate the error.
ERRORS
The catgets() function may fail if:
EBADF The catd argument is not a valid message catalogue descriptor open for reading.
EINTR The read operation was terminated due to the receipt of a signal, and no data was transferred.
EINVAL The message catalog identified by catd is corrupted.
ENOMSG
The message identified by set_id and msg_id is not in the message catalog.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
| MT-Level | MT-Safe |
SEE ALSO
gencat(1), catclose(3C), catopen(3C), gettext(3C), setlocale(3C), attributes(5)
Solaris Internationalization Guide For Developers
NOTES
catgets() can be used safely in a multi-thread application, as long as setlocale(3C) is not being called to change the locale.
SunOS 5.6 — Last change: 29 Dec 1996