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



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

NNAAMMEE
       catgets -- read a program message

SSYYNNOOPPSSIISS
       #include <nl_types.h>

       char *catgets(nl_catd _c_a_t_d, int _s_e_t___i_d, int _m_s_g___i_d, const char *_s);

DDEESSCCRRIIPPTTIIOONN
       The _c_a_t_g_e_t_s() function shall attempt to read message _m_s_g___i_d, in set
       _s_e_t___i_d, from the message catalog identified by _c_a_t_d.  The _c_a_t_d argument
       is a message catalog descriptor returned from an earlier call to
       _c_a_t_o_p_e_n().  The results are undefined if _c_a_t_d is not a value returned
       by _c_a_t_o_p_e_n() for a message catalog still open in the process. The _s
       argument points to a default message string which shall be returned by
       _c_a_t_g_e_t_s() if it cannot retrieve the identified message.

       The _c_a_t_g_e_t_s() function need not be thread-safe.

RREETTUURRNN VVAALLUUEE
       If the identified message is retrieved successfully, _c_a_t_g_e_t_s() 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 _e_r_r_n_o shall be set to indicate the error.

EERRRROORRSS
       The _c_a_t_g_e_t_s() function shall fail if:

       EEIINNTTRR  The read operation was terminated due to the receipt of a
              signal, and no data was transferred.

       EENNOOMMSSGG The message identified by _s_e_t___i_d and _m_s_g___i_d is not in the
              message catalog.

       The _c_a_t_g_e_t_s() function may fail if:

       EEBBAADDFF  The _c_a_t_d argument is not a valid message catalog descriptor open
              for reading.

       EEBBAADDMMSSGG
              The message identified by _s_e_t___i_d and _m_s_g___i_d in the specified
              message catalog did not satisfy implementation-defined security
              criteria.

       EEIINNVVAALL The message catalog identified by _c_a_t_d is corrupted.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _c_a_t_c_l_o_s_e(), _c_a_t_o_p_e_n()

       The Base Definitions volume of POSIX.1-2017, <<nnll__ttyyppeess..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 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 .

       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                  2017                           CATGETS(3)
