catgets man page

Prolog

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

catgets — read a program message

Synopsis

#include <nl_types.h>

char *catgets(nl_catd catd, int set_id, int msg_id, const char *s);

Description

The catgets() function shall attempt to read message msg_id, in set set_id, from the message catalog identified by catd. The catd argument is a message catalog descriptor returned from an earlier call to catopen(). The results are undefined if catd is not a value returned by catopen() for a message catalog still open in the process. The s argument points to a default message string which shall be returned by catgets() if it cannot retrieve the identified message.

The catgets() function need not be thread-safe.

Return Value

If the identified message is retrieved successfully, catgets() shall return a pointer to an internal buffer area containing the null-terminated message string. If the call is unsuccessful for any reason, s shall be returned and errno shall be set to indicate the error.

Errors

The catgets() function shall fail if:

EINTR
The read operation was terminated due to the receipt of a signal, and no data was transferred.
ENOMSG
The message identified by set_id and msg_id is not in the message catalog.

The catgets() function may fail if:

EBADF
The catd argument is not a valid message catalog descriptor open for reading.
EBADMSG
The message identified by set_id and msg_id in the specified message catalog did not satisfy implementation-defined security criteria.
EINVAL
The message catalog identified by catd is corrupted.

The following sections are informative.

See Also

catclose(), catopen()

The Base Definitions volume of POSIX.1‐2008, <nl_types.h>

Info

2013 IEEE/The Open Group POSIX Programmer's Manual