Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

catgets(3) [freebsd man page]

CATGETS(3)						   BSD Library Functions Manual 						CATGETS(3)

NAME
catgets -- retrieve string from message catalog LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <nl_types.h> char * catgets(nl_catd catd, int set_id, int msg_id, const char *s); DESCRIPTION
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. RETURN VALUES
If the specified message was retrieved successfully, catgets() returns a pointer to an internal buffer containing the message string; other- wise it returns s. ERRORS
[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. SEE ALSO
gencat(1), catclose(3), catopen(3) STANDARDS
The catgets() function conforms to IEEE Std 1003.1-2001 (``POSIX.1''). BSD
February 12, 2005 BSD

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