mbstate_t(3type) — Linux manual page

mbstate_t(3type)                                        mbstate_t(3type)

NAME

       mbstate_t - multi-byte-character conversion state

LIBRARY

       Standard C library (libc)

SYNOPSIS

       #include <wchar.h>

       typedef /* ... */  mbstate_t;

DESCRIPTION

       Character conversion between the multibyte representation and the
       wide character representation uses conversion state, of type
       mbstate_t.  Conversion of a string uses a finite-state machine;
       when it is interrupted after the complete conversion of a number
       of characters, it may need to save a state for processing the
       remaining characters.  Such a conversion state is needed for the
       sake of encodings such as ISO/IEC 2022 and UTF-7.

       The initial state is the state at the beginning of conversion of
       a string.  There are two kinds of state: the one used by
       multibyte to wide character conversion functions, such as
       mbsrtowcs(3), and the one used by wide character to multibyte
       conversion functions, such as wcsrtombs(3), but they both fit in
       a mbstate_t, and they both have the same representation for an
       initial state.

       For 8-bit encodings, all states are equivalent to the initial
       state.  For multibyte encodings like UTF-8, EUC-*, BIG5, or SJIS,
       the wide character to multibyte conversion functions never
       produce non-initial states, but the multibyte to wide-character
       conversion functions like mbrtowc(3) do produce non-initial
       states when interrupted in the middle of a character.

       One possible way to create an mbstate_t in initial state is to
       set it to zero:

           mbstate_t state;
           memset(&state, 0, sizeof(state));

       On Linux, the following works as well, but might generate
       compiler warnings:

           mbstate_t state = { 0 };

STANDARDS

       C11, POSIX.1-2008.

HISTORY

       C99, POSIX.1-2001.

SEE ALSO

       mbrlen(3), mbrtowc(3), mbsinit(3), mbsrtowcs(3), wcrtomb(3),
       wcsrtombs(3)

COLOPHON

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-03               mbstate_t(3type)

Pages that refer to this page: mbsinit(3)

---