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/
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.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, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" ISO/IEC 9899:1999
|
|
|
|
.\"
|
|
|
|
.TH MBSRTOWCS 3 1999-07-25 "GNU" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
2007-04-24 19:40:35 +00:00
|
|
|
mbsrtowcs \- convert a multibyte string to a wide-character string
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <wchar.h>
|
|
|
|
.sp
|
|
|
|
.BI "size_t mbsrtowcs(wchar_t *" dest ", const char **" src ,
|
|
|
|
.BI " size_t " len ", mbstate_t *" ps );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
If \fIdest\fP is not a NULL pointer, the
|
|
|
|
.BR mbsrtowcs ()
|
|
|
|
function converts the
|
2004-11-03 13:51:07 +00:00
|
|
|
multibyte string \fI*src\fP to a wide-character string starting at \fIdest\fP.
|
2007-04-12 22:42:49 +00:00
|
|
|
At most \fIlen\fP wide characters are written to \fIdest\fP.
|
|
|
|
The shift state
|
|
|
|
\fI*ps\fP is updated.
|
|
|
|
The conversion is effectively performed by repeatedly
|
2007-07-18 20:11:21 +00:00
|
|
|
calling
|
2007-09-20 16:26:31 +00:00
|
|
|
.I "mbrtowc(dest, *src, n, ps)"
|
2007-07-18 20:11:21 +00:00
|
|
|
where \fIn\fP is some
|
2004-11-03 13:51:07 +00:00
|
|
|
positive number, as long as this call succeeds, and then incrementing
|
2007-04-12 22:42:49 +00:00
|
|
|
\fIdest\fP by one and \fI*src\fP by the number of bytes consumed.
|
|
|
|
The conversion can stop for three reasons:
|
2007-12-24 15:04:43 +00:00
|
|
|
.IP 1. 3
|
|
|
|
An invalid multibyte sequence has been encountered.
|
2007-04-12 22:42:49 +00:00
|
|
|
In this case \fI*src\fP
|
2007-07-09 21:33:55 +00:00
|
|
|
is left pointing to the invalid multibyte sequence,
|
2007-12-22 16:26:51 +00:00
|
|
|
.I (size_t)\ \-1
|
2007-07-09 21:33:55 +00:00
|
|
|
is returned,
|
2006-02-09 20:29:51 +00:00
|
|
|
and \fIerrno\fP is set to \fBEILSEQ\fP.
|
2007-12-24 15:04:43 +00:00
|
|
|
.IP 2.
|
2008-06-09 15:49:35 +00:00
|
|
|
\fIlen\fP non-L\(aq\\0\(aq wide characters have been stored at \fIdest\fP.
|
2007-04-12 22:42:49 +00:00
|
|
|
In this
|
2007-12-13 20:46:52 +00:00
|
|
|
case \fI*src\fP is left pointing to the next
|
|
|
|
multibyte sequence to be converted,
|
2004-11-03 13:51:07 +00:00
|
|
|
and the number of wide characters written to \fIdest\fP is returned.
|
2007-12-24 15:04:43 +00:00
|
|
|
.IP 3.
|
|
|
|
The multibyte string has been completely converted, including the
|
2008-06-09 15:49:35 +00:00
|
|
|
terminating \(aq\\0\(aq (which has the side
|
2007-12-13 20:46:52 +00:00
|
|
|
effect of bringing back \fI*ps\fP to the
|
2007-04-12 22:42:49 +00:00
|
|
|
initial state).
|
|
|
|
In this case \fI*src\fP is set to NULL, and the number of wide
|
2007-12-13 20:46:52 +00:00
|
|
|
characters written to \fIdest\fP,
|
2008-06-09 15:49:35 +00:00
|
|
|
excluding the terminating L\(aq\\0\(aq character, is returned.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-12-13 20:46:52 +00:00
|
|
|
If \fIdest\fP is NULL, \fIlen\fP is ignored,
|
|
|
|
and the conversion proceeds as above,
|
|
|
|
except that the converted wide characters are not written out to memory,
|
2004-11-03 13:51:07 +00:00
|
|
|
and that no length limit exists.
|
|
|
|
.PP
|
2007-12-13 20:46:52 +00:00
|
|
|
In both of the above cases,
|
|
|
|
if \fIps\fP is a NULL pointer, a static anonymous
|
|
|
|
state only known to the
|
|
|
|
.BR mbsrtowcs ()
|
|
|
|
function is used instead.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
The programmer must ensure that there is room for at least \fIlen\fP wide
|
|
|
|
characters at \fIdest\fP.
|
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR mbsrtowcs ()
|
|
|
|
function returns the number of wide characters that make
|
2007-04-24 19:40:35 +00:00
|
|
|
up the converted part of the wide-character string, not including the
|
2007-04-12 22:42:49 +00:00
|
|
|
terminating null wide character.
|
|
|
|
If an invalid multibyte sequence was
|
2007-07-09 21:33:55 +00:00
|
|
|
encountered,
|
2007-12-22 16:26:51 +00:00
|
|
|
.I (size_t)\ \-1
|
2007-07-09 21:33:55 +00:00
|
|
|
is returned, and \fIerrno\fP set to \fBEILSEQ\fP.
|
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 mbsrtowcs ()
|
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
|
|
|
Passing NULL as \fIps\fP is not multithread safe.
|
2007-05-16 18:25:50 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR iconv (3),
|
|
|
|
.BR mbsnrtowcs (3),
|
|
|
|
.BR mbstowcs (3)
|