Man Pages

catgets(3p) - phpMan catgets(3p) - phpMan

Command: man perldoc info search(apropos)  


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 dif-
       fer (consult the corresponding 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-terminated 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 implementa-
              tion-defined security criteria.

       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, Stan-
       dard  for  Information  Technology  --  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)