2004-11-03 13:51:07 +00:00
|
|
|
.\" 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
|
2007-04-12 22:42:49 +00:00
|
|
|
not NULL.
|
2007-05-12 09:06:04 +00:00
|
|
|
In this case, the
|
|
|
|
.BR mbtowc ()
|
|
|
|
function inspects at most \fIn\fP
|
2007-04-12 22:42:49 +00:00
|
|
|
bytes of the multibyte string starting at \fIs\fP,
|
|
|
|
extracts the next complete
|
2004-11-03 13:51:07 +00:00
|
|
|
multibyte character, converts it to a wide character and stores it at
|
2007-04-12 22:42:49 +00:00
|
|
|
\fI*pwc\fP.
|
|
|
|
It updates an internal shift state only known to the mbtowc
|
|
|
|
function.
|
2008-06-09 15:49:35 +00:00
|
|
|
If \fIs\fP does not point to a \(aq\\0\(aq byte, it returns the number
|
2004-11-03 13:51:07 +00:00
|
|
|
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
|
2007-05-12 09:06:04 +00:00
|
|
|
character, or if they contain an invalid multibyte sequence,
|
|
|
|
.BR mbtowc ()
|
2007-04-27 17:25:28 +00:00
|
|
|
returns \-1.
|
2007-04-12 22:42:49 +00:00
|
|
|
This can happen even if \fIn\fP >= \fIMB_CUR_MAX\fP,
|
2004-11-03 13:51:07 +00:00
|
|
|
if the multibyte string contains redundant shift sequences.
|
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
A different case is when \fIs\fP is not NULL but \fIpwc\fP is NULL.
|
|
|
|
In this
|
2007-05-12 09:06:04 +00:00
|
|
|
case the
|
|
|
|
.BR mbtowc ()
|
2007-11-17 04:27:41 +00:00
|
|
|
function behaves as above, except that it does not
|
2004-11-03 13:51:07 +00:00
|
|
|
store the converted wide character in memory.
|
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
A third case is when \fIs\fP is NULL.
|
|
|
|
In this case, \fIpwc\fP and \fIn\fP are
|
|
|
|
ignored.
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR mbtowc ()
|
|
|
|
function
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" The Dinkumware doc and the Single Unix specification say this, but
|
|
|
|
.\" glibc doesn't implement this.
|
2007-04-12 22:42:49 +00:00
|
|
|
resets the shift state, only known to this function,
|
|
|
|
to the initial state, and
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
returns nonzero if the encoding has nontrivial shift state, or zero if the
|
2004-11-03 13:51:07 +00:00
|
|
|
encoding is stateless.
|
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
If \fIs\fP is not NULL, the
|
|
|
|
.BR mbtowc ()
|
|
|
|
function returns the number of
|
2004-11-03 13:51:07 +00:00
|
|
|
consumed bytes starting at \fIs\fP, or 0 if \fIs\fP points to a null byte,
|
|
|
|
or \-1 upon failure.
|
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
If \fIs\fP is NULL, the
|
|
|
|
.BR mbtowc ()
|
|
|
|
function
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
returns nonzero if the encoding
|
2007-12-25 22:02:19 +00:00
|
|
|
has nontrivial shift state, or zero if the encoding is stateless.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2008-07-15 13:39:17 +00:00
|
|
|
C99.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NOTES
|
2007-06-08 09:56:56 +00:00
|
|
|
The behavior of
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR mbtowc ()
|
2007-06-22 18:25:23 +00:00
|
|
|
depends on the
|
|
|
|
.B LC_CTYPE
|
|
|
|
category of the
|
2004-11-03 13:51:07 +00:00
|
|
|
current locale.
|
|
|
|
.PP
|
2008-11-19 19:31:54 +00:00
|
|
|
This function is not multithread safe.
|
2007-05-12 09:06:04 +00:00
|
|
|
The function
|
|
|
|
.BR mbrtowc (3)
|
|
|
|
provides
|
2004-11-03 13:51:07 +00:00
|
|
|
a better interface to the same functionality.
|
2007-05-16 18:25:50 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR MB_CUR_MAX (3),
|
|
|
|
.BR mbrtowc (3),
|
|
|
|
.BR mbstowcs (3)
|