Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

catgets(3) [minix man page]

CATGETS(3)						     Linux Programmer's Manual							CATGETS(3)

NAME
catgets - get message from a message catalog SYNOPSIS
#include <nl_types.h> char *catgets(nl_catd catalog, int set_number, int message_number, const char *message); DESCRIPTION
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 (''). RETURN VALUE
On success, catgets() returns a pointer to an internal buffer area containing the null-terminated message string. On failure, catgets() returns the value message. ATTRIBUTES
For an explanation of the terms used in this section, see attributes(7). +----------+---------------+---------+ |Interface | Attribute | Value | +----------+---------------+---------+ |catgets() | Thread safety | MT-Safe | +----------+---------------+---------+ CONFORMING TO
POSIX.1-2001, POSIX.1-2008. NOTES
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 mes- sage 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. SEE ALSO
catopen(3), setlocale(3) COLOPHON
This page is part of release 4.15 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/. 2015-08-08 CATGETS(3)

Check Out this Related Man Page

catgets(3C)						   Standard C Library Functions 					       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
The catgets() function attempts to read message msg_num, in set set_num, from the message catalog identified by catd. The catd argument is a catalog descriptor returned from an earlier call to catopen(). The s argument 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 termi- nated 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. EBADMSG The number of %n specifiers that appear in the message string specified by s does not match the number of %n specifiers that appear in the message identified by set_id and msg_id in the specified message catalog. 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. USAGE
The catgets() function can be used safely in multithreaded applications as long as setlocale(3C) is not being called to change the locale. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
gencat(1), catclose(3C), catopen(3C), gettext(3C), setlocale(3C), attributes(5), standards(5) International Language Environments Guide SunOS 5.10 22 Mar 2002 catgets(3C)
Man Page