GETS(3)                    POSIX Programmer's Manual                   GETS(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
       gets -- get a string from a _s_t_d_i_n stream

SSYYNNOOPPSSIISS
       #include <stdio.h>

       char *gets(char *_s);

DDEESSCCRRIIPPTTIIOONN
       The functionality described on this reference page is aligned with the
       ISO C standard. Any conflict between the requirements described here
       and the ISO C standard is unintentional. This volume of POSIX.1-2017
       defers to the ISO C standard.

       The _g_e_t_s() function shall read bytes from the standard input stream,
       _s_t_d_i_n, into the array pointed to by _s, until a <newline> is read or an
       end-of-file condition is encountered. Any <newline> shall be discarded
       and a null byte shall be placed immediately after the last byte read
       into the array.

       The _g_e_t_s() function may mark the last data access timestamp of the file
       associated with _s_t_r_e_a_m for update. The last data access timestamp shall
       be marked for update by the first successful execution of _f_g_e_t_c(),
       _f_g_e_t_s(), _f_r_e_a_d(), _f_s_c_a_n_f(), _g_e_t_c(), _g_e_t_c_h_a_r(), _g_e_t_d_e_l_i_m(), _g_e_t_l_i_n_e(),
       _g_e_t_s(), or _s_c_a_n_f() using _s_t_r_e_a_m that returns data not supplied by a
       prior call to _u_n_g_e_t_c().

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _g_e_t_s() shall return _s.  If the end-of-file
       indicator for the stream is set, or if the stream is at end-of-file,
       the end-of-file indicator for the stream shall be set and _g_e_t_s() shall
       return a null pointer. If a read error occurs, the error indicator for
       the stream shall be set, _g_e_t_s() shall return a null pointer, and set
       _e_r_r_n_o to indicate the error.

EERRRROORRSS
       Refer to _f_g_e_t_c().

       _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
       Reading a line that overflows the array pointed to by _s results in
       undefined behavior. The use of _f_g_e_t_s() is recommended.

       Since the user cannot specify the length of the buffer passed to
       _g_e_t_s(), use of this function is discouraged. The length of the string
       read is unlimited. It is possible to overflow this buffer in such a way
       as to cause applications to fail, or possible system security
       violations.

       Applications should use the _f_g_e_t_s() function instead of the obsolescent
       _g_e_t_s() function.

RRAATTIIOONNAALLEE
       The standard developers decided to mark the _g_e_t_s() function as
       obsolescent even though it is in the ISO C standard due to the
       possibility of buffer overflow.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       The _g_e_t_s() function may be removed in a future version.

SSEEEE AALLSSOO
       _S_e_c_t_i_o_n _2_._5, _S_t_a_n_d_a_r_d _I_/_O _S_t_r_e_a_m_s, _f_e_o_f(), _f_e_r_r_o_r(), _f_g_e_t_s()

       The Base Definitions volume of POSIX.1-2017, <<ssttddiioo..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                              GETS(3)
