1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
4 .\" This is free documentation; you can redistribute it and/or
5 .\" modify it under the terms of the GNU General Public License as
6 .\" published by the Free Software Foundation; either version 2 of
7 .\" the License, or (at your option) any later version.
10 .\" References consulted:
11 .\" GNU glibc-2 source code and manual
12 .\" Dinkumware C library reference http://www.dinkumware.com/
13 .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
16 .TH MBTOWC 3 2011-09-28 "GNU" "Linux Programmer's Manual"
18 mbtowc \- convert a multibyte sequence to a wide character
21 .B #include <stdlib.h>
23 .BI "int mbtowc(wchar_t *" pwc ", const char *" s ", size_t " n );
26 The main case for this function is when \fIs\fP is not NULL and \fIpwc\fP is
30 function inspects at most \fIn\fP
31 bytes of the multibyte string starting at \fIs\fP,
32 extracts the next complete
33 multibyte character, converts it to a wide character and stores it at
35 It updates an internal shift state only known to the mbtowc
37 If \fIs\fP does not point to a null byte (\(aq\\0\(aq), it returns the number
38 of bytes that were consumed from \fIs\fP, otherwise it returns 0.
40 If the \fIn\fP bytes starting at \fIs\fP do not contain a complete multibyte
41 character, or if they contain an invalid multibyte sequence,
44 This can happen even if \fIn\fP >= \fIMB_CUR_MAX\fP,
45 if the multibyte string contains redundant shift sequences.
47 A different case is when \fIs\fP is not NULL but \fIpwc\fP is NULL.
51 function behaves as above, except that it does not
52 store the converted wide character in memory.
54 A third case is when \fIs\fP is NULL.
55 In this case, \fIpwc\fP and \fIn\fP are
60 .\" The Dinkumware doc and the Single UNIX specification say this, but
61 .\" glibc doesn't implement this.
62 resets the shift state, only known to this function,
63 to the initial state, and
64 returns nonzero if the encoding has nontrivial shift state, or zero if the
65 encoding is stateless.
67 If \fIs\fP is not NULL, the
69 function returns the number of
70 consumed bytes starting at \fIs\fP, or 0 if \fIs\fP points to a null byte,
73 If \fIs\fP is NULL, the
76 returns nonzero if the encoding
77 has nontrivial shift state, or zero if the encoding is stateless.
88 This function is not multithread safe.
92 a better interface to the same functionality.