btowc(3) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ATTRIBUTES | STANDARDS | HISTORY | NOTES | SEE ALSO | COLOPHON

btowc(3)                Library Functions Manual                btowc(3)

NAME         top

       btowc - convert single byte to wide character

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <wchar.h>

       wint_t btowc(int c);

DESCRIPTION         top

       The btowc() function converts c, interpreted as a multibyte
       sequence of length 1, starting in the initial shift state, to a
       wide character and returns it.  If c is EOF or not a valid
       multibyte sequence of length 1, the btowc() function returns
       WEOF.

RETURN VALUE         top

       The btowc() function returns the wide character converted from
       the single byte c.  If c is EOF or not a valid multibyte sequence
       of length 1, it returns WEOF.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌─────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                           Attribute     Value   │
       ├─────────────────────────────────────┼───────────────┼─────────┤
       │ btowc()                             │ Thread safety │ MT-Safe │
       └─────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       C11, POSIX.1-2008.

HISTORY         top

       C99, POSIX.1-2001.

NOTES         top

       The behavior of btowc() depends on the LC_CTYPE category of the
       current locale.

       This function should never be used.  It does not work for
       encodings which have state, and unnecessarily treats single bytes
       differently from multibyte sequences.  Use either mbtowc(3) or
       the thread-safe mbrtowc(3) instead.

SEE ALSO         top

       mbrtowc(3), mbtowc(3), wctob(3)

COLOPHON         top

       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-02                       btowc(3)

Pages that refer to this page: wctob(3)wprintf(3)