catgets(3p) [posix man page]

CATGETS(3P)						     POSIX Programmer's Manual						       CATGETS(3P)

PROLOG

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

NAME

       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-termi-
       nated 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  crite-
	      ria.

       EINVAL The message catalog identified by catd is corrupted.

       The following sections are informative.

EXAMPLES

       None.

APPLICATION USAGE

       None.

RATIONALE

       None.

FUTURE DIRECTIONS

       None.

SEE ALSO

       catclose(), catopen()

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

COPYRIGHT

       Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2013 Edition, Standard for Information Technol-
       ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, Copyright (C)  2013  by	the  Institute	of
       Electrical and Electronics Engineers, Inc and The Open Group.  (This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
       event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Stan-
       dard is the referee document. The original Standard can be obtained online at http://www.unix.org/online.html .

       Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .

IEEE
/The Open Group						       2013							       CATGETS(3P)

Check Out this Related 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)

Linux and UNIX Man Pages

catgets(3p) [posix man page]

Check Out this Related Man Page