diff options
author | Tim J. Robbins <tjr@FreeBSD.org> | 2002-08-18 06:30:10 +0000 |
---|---|---|
committer | Tim J. Robbins <tjr@FreeBSD.org> | 2002-08-18 06:30:10 +0000 |
commit | e92a3d83fcba95f35d5f162df92f2d5b8351c2e3 (patch) | |
tree | b0db833aa303e27ab11b105a22ad20569ca28d93 /lib/libc/locale/mbsrtowcs.3 | |
parent | b9414ee6bc1d26205a80e0445de324509dd0caed (diff) | |
download | src-e92a3d83fcba95f35d5f162df92f2d5b8351c2e3.tar.gz src-e92a3d83fcba95f35d5f162df92f2d5b8351c2e3.zip |
Notes
Diffstat (limited to 'lib/libc/locale/mbsrtowcs.3')
-rw-r--r-- | lib/libc/locale/mbsrtowcs.3 | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/lib/libc/locale/mbsrtowcs.3 b/lib/libc/locale/mbsrtowcs.3 new file mode 100644 index 000000000000..3c38a463ab33 --- /dev/null +++ b/lib/libc/locale/mbsrtowcs.3 @@ -0,0 +1,108 @@ +.\" Copyright (c) 2002 Tim J. Robbins +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.Dd August 16, 2002 +.Dt MBSRTOWCS 3 +.Os +.Sh NAME +.Nm mbsrtowcs +.Nd "convert a character string to a wide-character string (restartable)" +.Sh LIBRARY +.Lb libc +.Sh SYNOPSIS +.In wchar.h +.Ft size_t +.Fn mbsrtowcs "wchar_t *restrict dst" "const char **restrict src" "size_t len" "mbstate_t *restrict ps" +.Sh DESCRIPTION +The +.Fn mbsrtowcs +function converts a sequence of multibyte characters pointed to indirectly by +.Fa src +into a sequence of corresponding wide characters and stores at most +.Fa len +of them in the +.Ft wchar_t +array pointed to by +.Fa dst , +until it encounters a terminating null character ('\e0'). +.Pp +If +.Fa dst +is +.Dv NULL , +no characters are stored. +.Pp +If +.Fa dst +is not +.Dv NULL , +the pointer pointed to by +.Fa src +is updated to point to the character after the one that conversion stopped at. +If conversion stops because a null character is encountered, +.No * Ns Fa src +is set to +.Dv NULL . +.Pp +The +.Ft mbstate_t +argument, +.Fa ps , +is used to keep track of the shift state. +If it is +.Dv NULL , +.Fn mbsrtowcs +uses an internal, static +.Ft mbstate_t +object. +.Sh RETURN VALUES +The +.Fn mbsrtowcs +function returns the number of wide characters stored in +the array pointed to by +.Fa dst +if successful, otherwise it returns +.No ( Ns +.Ft size_t Ns +.No ) Ns -1 . +.Sh ERRORS +The +.Fn mbsrtowcs +function will fail if: +.Bl -tag -width Er +.It Bq Er EILSEQ +An invalid multibyte character sequence was encountered. +.El +.Sh SEE ALSO +.Xr mbrtowc 3 , +.Xr mbstowcs 3 , +.Xr wcsrtombs 3 +.Sh STANDARDS +The +.Fn mbsrtowcs +function conforms to +.St -isoC-99 . +.Sh BUGS +The current implementation does not support shift states. |