FGETWS(3)                  POSIX Programmer's Manual                 FGETWS(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
       fgetws -- get a wide-character string from a stream

SSYYNNOOPPSSIISS
       #include <stdio.h>
       #include <wchar.h>

       wchar_t *fgetws(wchar_t *restrict _w_s, int _n,
           FILE *restrict _s_t_r_e_a_m);

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-2008
       defers to the ISO C standard.

       The _f_g_e_t_w_s() function shall read characters from the _s_t_r_e_a_m, convert
       these to the corresponding wide-character codes, place them in the
       wwcchhaarr__tt array pointed to by _w_s, until _n-1 characters are read, or a
       <newline> is read, converted, and transferred to _w_s, or an end-of-file
       condition is encountered. The wide-character string, _w_s, shall then be
       terminated with a null wide-character code.

       If an error occurs, the resulting value of the file position indicator
       for the stream is unspecified.

       The _f_g_e_t_w_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_w_c(), _f_g_e_t_w_s(), _f_w_s_c_a_n_f(), _g_e_t_w_c(), _g_e_t_w_c_h_a_r(), _v_f_w_s_c_a_n_f(),
       _v_w_s_c_a_n_f(), or _w_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_w_c().

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _f_g_e_t_w_s() shall return _w_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
       _f_g_e_t_w_s() shall return a null pointer. If a read error occurs, the error
       indicator for the stream shall be set, _f_g_e_t_w_s() shall return a null
       pointer, and shall set _e_r_r_n_o to indicate the error.

EERRRROORRSS
       Refer to _f_g_e_t_w_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
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

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_o_p_e_n(), _f_r_e_a_d()

       The Base Definitions volume of POSIX.1-2008, <<ssttddiioo..hh>>, <<wwcchhaarr..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
       -- 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 Standard
       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                            FGETWS(3)
