mirror of https://github.com/mkerrisk/man-pages
95 lines
2.8 KiB
Groff
95 lines
2.8 KiB
Groff
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
.\"
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
.\" the License, or (at your option) any later version.
|
|
.\"
|
|
.\" References consulted:
|
|
.\" GNU glibc-2 source code and manual
|
|
.\" Dinkumware C library reference http://www.dinkumware.com/
|
|
.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
|
|
.\" ISO/IEC 9899:1999
|
|
.\"
|
|
.TH MBTOWC 3 2001-07-04 "GNU" "Linux Programmer's Manual"
|
|
.SH NAME
|
|
mbtowc \- convert a multibyte sequence to a wide character
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.B #include <stdlib.h>
|
|
.sp
|
|
.BI "int mbtowc(wchar_t *" pwc ", const char *" s ", size_t " n );
|
|
.fi
|
|
.SH DESCRIPTION
|
|
The main case for this function is when \fIs\fP is not NULL and \fIpwc\fP is
|
|
not NULL.
|
|
In this case, the
|
|
.BR mbtowc ()
|
|
function inspects at most \fIn\fP
|
|
bytes of the multibyte string starting at \fIs\fP,
|
|
extracts the next complete
|
|
multibyte character, converts it to a wide character and stores it at
|
|
\fI*pwc\fP.
|
|
It updates an internal shift state only known to the mbtowc
|
|
function.
|
|
If \fIs\fP does not point to a \(aq\\0\(aq byte, it returns the number
|
|
of bytes that were consumed from \fIs\fP, otherwise it returns 0.
|
|
.PP
|
|
If the \fIn\fP bytes starting at \fIs\fP do not contain a complete multibyte
|
|
character, or if they contain an invalid multibyte sequence,
|
|
.BR mbtowc ()
|
|
returns \-1.
|
|
This can happen even if \fIn\fP >= \fIMB_CUR_MAX\fP,
|
|
if the multibyte string contains redundant shift sequences.
|
|
.PP
|
|
A different case is when \fIs\fP is not NULL but \fIpwc\fP is NULL.
|
|
In this
|
|
case the
|
|
.BR mbtowc ()
|
|
function behaves as above, except that it does not
|
|
store the converted wide character in memory.
|
|
.PP
|
|
A third case is when \fIs\fP is NULL.
|
|
In this case, \fIpwc\fP and \fIn\fP are
|
|
ignored.
|
|
The
|
|
.BR mbtowc ()
|
|
function
|
|
.\" The Dinkumware doc and the Single Unix specification say this, but
|
|
.\" glibc doesn't implement this.
|
|
resets the shift state, only known to this function,
|
|
to the initial state, and
|
|
returns non-zero if the encoding has nontrivial shift state, or zero if the
|
|
encoding is stateless.
|
|
.SH "RETURN VALUE"
|
|
If \fIs\fP is not NULL, the
|
|
.BR mbtowc ()
|
|
function returns the number of
|
|
consumed bytes starting at \fIs\fP, or 0 if \fIs\fP points to a null byte,
|
|
or \-1 upon failure.
|
|
.PP
|
|
If \fIs\fP is NULL, the
|
|
.BR mbtowc ()
|
|
function
|
|
returns non-zero if the encoding
|
|
has nontrivial shift state, or zero if the encoding is stateless.
|
|
.SH "CONFORMING TO"
|
|
C99
|
|
.SH NOTES
|
|
The behavior of
|
|
.BR mbtowc ()
|
|
depends on the
|
|
.B LC_CTYPE
|
|
category of the
|
|
current locale.
|
|
.PP
|
|
This function is not multi-thread safe.
|
|
The function
|
|
.BR mbrtowc (3)
|
|
provides
|
|
a better interface to the same functionality.
|
|
.SH "SEE ALSO"
|
|
.BR MB_CUR_MAX (3),
|
|
.BR mbrtowc (3),
|
|
.BR mbstowcs (3)
|