92 lines
3.2 KiB
Groff
92 lines
3.2 KiB
Groff
.\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
|
|
.\" Copyright (c) 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to Berkeley by
|
|
.\" Donn Seeley of BSDI.
|
|
.\"
|
|
.\" 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.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
|
|
.\"
|
|
.\" From @(#)multibyte.3 8.1 (Berkeley) 6/4/93
|
|
.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd April 8, 2004
|
|
.Dt MBSTOWCS 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm mbstowcs
|
|
.Nd convert a character string to a wide-character string
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In stdlib.h
|
|
.Ft size_t
|
|
.Fo mbstowcs
|
|
.Fa "wchar_t * restrict wcstring" "const char * restrict mbstring"
|
|
.Fa "size_t nwchars"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn mbstowcs
|
|
function converts a multibyte character string
|
|
.Fa mbstring
|
|
beginning in the initial conversion state
|
|
into a wide character string
|
|
.Fa wcstring .
|
|
No more than
|
|
.Fa nwchars
|
|
wide characters are stored.
|
|
A terminating null wide character is appended if there is room.
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn mbstowcs
|
|
function returns the number of wide characters converted,
|
|
not counting any terminating null wide character, or \-1
|
|
if an invalid multibyte character was encountered.
|
|
.Sh ERRORS
|
|
The
|
|
.Fn mbstowcs
|
|
function will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EILSEQ
|
|
An invalid multibyte sequence was detected.
|
|
.It Bq Er EINVAL
|
|
The conversion state is invalid.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr mbsrtowcs 3 ,
|
|
.Xr mbtowc 3 ,
|
|
.Xr multibyte 3
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn mbstowcs
|
|
function conforms to
|
|
.St -isoC-99 .
|