Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

catgets(3c) [opensolaris 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.11 22 Mar 2002 catgets(3C)

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 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 reentrant. A function that is not required to be reentrant is not required to 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 may be set to indicate the error. ERRORS
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. 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. The following sections are informative. EXAMPLES
None. APPLICATION USAGE
None. RATIONALE
None. FUTURE DIRECTIONS
None. SEE ALSO
catclose(), catopen(), the Base Definitions volume of IEEE Std 1003.1-2001, <nl_types.h> COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technol- ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. 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 Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html . IEEE
/The Open Group 2003 CATGETS(3P)
Man Page