NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ATTRIBUTES | VERSIONS | STANDARDS | HISTORY | NOTES | SEE ALSO | COLOPHON |
|
|
mblen(3) Library Functions Manual mblen(3)
mblen - determine number of bytes in next multibyte character
Standard C library (libc, -lc)
#include <stdlib.h> int mblen(const char s[.n], size_t n);
If s is not NULL, the mblen() function inspects at most n bytes of the multibyte string starting at s and extracts the next complete multibyte character. It uses a static anonymous shift state known only to the mblen() function. If the multibyte character is not the null wide character, it returns the number of bytes that were consumed from s. If the multibyte character is the null wide character, it returns 0. If the n bytes starting at s do not contain a complete multibyte character, mblen() returns -1. This can happen even if n is greater than or equal to MB_CUR_MAX, if the multibyte string contains redundant shift sequences. If the multibyte string starting at s contains an invalid multibyte sequence before the next complete character, mblen() also returns -1. If s is NULL, the mblen() function resets the shift state, known to only this function, to the initial state, and returns nonzero if the encoding has nontrivial shift state, or zero if the encoding is stateless.
The mblen() function returns the number of bytes parsed from the multibyte sequence starting at s, if a non-null wide character was recognized. It returns 0, if a null wide character was recognized. It returns -1, if an invalid multibyte sequence was encountered or if it couldn't parse a complete multibyte character.
For an explanation of the terms used in this section, see attributes(7). ┌──────────────────────────────┬───────────────┬────────────────┐ │ Interface │ Attribute │ Value │ ├──────────────────────────────┼───────────────┼────────────────┤ │ mblen() │ Thread safety │ MT-Unsafe race │ └──────────────────────────────┴───────────────┴────────────────┘
The function mbrlen(3) provides a better interface to the same functionality.
C11, POSIX.1-2008.
POSIX.1-2001, C99.
The behavior of mblen() depends on the LC_CTYPE category of the current locale.
mbrlen(3)
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
[email protected]
Linux man-pages 6.9.1 2024-05-02 mblen(3)
Pages that refer to this page: MB_CUR_MAX(3), mbstowcs(3), mbtowc(3), wcstombs(3), wctomb(3), locale(7)