WCSTOMBS(3)                POSIX Programmer's Manual               WCSTOMBS(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
       wcstombs -- convert a wide-character string to a character string

SSYYNNOOPPSSIISS
       #include <stdlib.h>

       size_t wcstombs(char *restrict _s, const wchar_t *restrict _p_w_c_s,
           size_t _n);

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 _w_c_s_t_o_m_b_s() function shall convert the sequence of wide-character
       codes that are in the array pointed to by _p_w_c_s into a sequence of
       characters that begins in the initial shift state and store these
       characters into the array pointed to by _s, stopping if a character
       would exceed the limit of _n total bytes or if a null byte is stored.
       Each wide-character code shall be converted as if by a call to
       _w_c_t_o_m_b(), except that the shift state of _w_c_t_o_m_b() shall not be
       affected.

       The behavior of this function shall be affected by the _L_C___C_T_Y_P_E
       category of the current locale.

       No more than _n bytes shall be modified in the array pointed to by _s.
       If copying takes place between objects that overlap, the behavior is
       undefined.  If _s is a null pointer, _w_c_s_t_o_m_b_s() shall return the length
       required to convert the entire array regardless of the value of _n, but
       no values are stored.

RREETTUURRNN VVAALLUUEE
       If a wide-character code is encountered that does not correspond to a
       valid character (of one or more bytes each), _w_c_s_t_o_m_b_s() shall return
       (ssiizzee__tt)-1. Otherwise, _w_c_s_t_o_m_b_s() shall return the number of bytes
       stored in the character array, not including any terminating null byte.
       The array shall not be null-terminated if the value returned is _n.

EERRRROORRSS
       The _w_c_s_t_o_m_b_s() function shall fail if:

       EEIILLSSEEQQ A wide-character code does not correspond to a valid character.

       _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
       _m_b_l_e_n(), _m_b_t_o_w_c(), _m_b_s_t_o_w_c_s(), _w_c_t_o_m_b()

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