MBSINIT(3)                 POSIX Programmer's Manual                MBSINIT(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
       mbsinit -- determine conversion object status

SSYYNNOOPPSSIISS
       #include <wchar.h>

       int mbsinit(const mbstate_t *_p_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.

       If _p_s is not a null pointer, the _m_b_s_i_n_i_t() function shall determine
       whether the object pointed to by _p_s describes an initial conversion
       state.

RREETTUURRNN VVAALLUUEE
       The _m_b_s_i_n_i_t() function shall return non-zero if _p_s is a null pointer,
       or if the pointed-to object describes an initial conversion state;
       otherwise, it shall return zero.

       If an mmbbssttaattee__tt object is altered by any of the functions described as
       ``restartable'', and is then used with a different character sequence,
       or in the other conversion direction, or with a different _L_C___C_T_Y_P_E
       category setting than on earlier function calls, the behavior is
       undefined.

EERRRROORRSS
       No errors are defined.

       _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
       The mmbbssttaattee__tt object is used to describe the current conversion state
       from a particular character sequence to a wide-character sequence (or
       _v_i_c_e _v_e_r_s_a) under the rules of a particular setting of the _L_C___C_T_Y_P_E
       category of the current locale.

       The initial conversion state corresponds, for a conversion in either
       direction, to the beginning of a new character sequence in the initial
       shift state. A zero valued mmbbssttaattee__tt object is at least one way to
       describe an initial conversion state. A zero valued mmbbssttaattee__tt object
       can be used to initiate conversion involving any character sequence, in
       any _L_C___C_T_Y_P_E category setting.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _m_b_r_l_e_n(), _m_b_r_t_o_w_c(), _m_b_s_r_t_o_w_c_s(), _w_c_r_t_o_m_b(), _w_c_s_r_t_o_m_b_s()

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