Manual Pages  — CATGETS

catgets – retrieve string from message catalog

LIBRARY SYNOPSIS DESCRIPTION RETURN VALUES ERRORS SEE ALSO STANDARDS

Standard C Library (libc, -lc)

#include <nl_types.h>

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

The catgets() function attempts to retrieve message msg_id of set set_id from the message catalog referenced by the descriptor catd. The argument s points to a default message which is returned if the function is unable to retrieve the specified message.

If the specified message was retrieved successfully, catgets() returns a pointer to an internal buffer containing the message string; otherwise it returns s.

[EBADF]
	The catd argument is not a valid message catalog descriptor.
[EBADMSG]
	The message identified by set_id and msg_id is not in the message catalog.

The catgets() function conforms to IEEE Std 1003.1-2001 ("POSIX.1").