mbstowcs.3 (bc0b3a180015087b0d8d3a1e4e4f881271d209f0) mbstowcs.3 (8b8109275c1a583e96171df08e3136151c02279e)
1.\" Copyright (c) 2002, 2003 Tim J. Robbins. All rights reserved.
1.\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
2.\" Copyright (c) 1993
3.\" The Regents of the University of California. All rights reserved.
4.\"
5.\" This code is derived from software contributed to Berkeley by
6.\" Donn Seeley of BSDI.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions

--- 22 unchanged lines hidden (view full) ---

32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\" From @(#)multibyte.3 8.1 (Berkeley) 6/4/93
37.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
38.\" $FreeBSD$
39.\"
2.\" Copyright (c) 1993
3.\" The Regents of the University of California. All rights reserved.
4.\"
5.\" This code is derived from software contributed to Berkeley by
6.\" Donn Seeley of BSDI.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions

--- 22 unchanged lines hidden (view full) ---

32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\" From @(#)multibyte.3 8.1 (Berkeley) 6/4/93
37.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
38.\" $FreeBSD$
39.\"
40.Dd November 19, 2003
40.Dd April 8, 2004
41.Dt MBSTOWCS 3
42.Os
43.Sh NAME
44.Nm mbstowcs
45.Nd convert a character string to a wide-character string
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.In stdlib.h
50.Ft size_t
51.Fn mbstowcs "wchar_t * restrict wcstring" "const char * restrict mbstring" "size_t nwchars"
52.Sh DESCRIPTION
53The
54.Fn mbstowcs
55function converts a multibyte character string
56.Fa mbstring
41.Dt MBSTOWCS 3
42.Os
43.Sh NAME
44.Nm mbstowcs
45.Nd convert a character string to a wide-character string
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.In stdlib.h
50.Ft size_t
51.Fn mbstowcs "wchar_t * restrict wcstring" "const char * restrict mbstring" "size_t nwchars"
52.Sh DESCRIPTION
53The
54.Fn mbstowcs
55function converts a multibyte character string
56.Fa mbstring
57beginning in the initial conversion state
57into a wide character string
58.Fa wcstring .
59No more than
60.Fa nwchars
61wide characters are stored.
62A terminating null wide character is appended if there is room.
63.Sh RETURN VALUES
64The
65.Fn mbstowcs
66function returns the number of wide characters converted,
67not counting any terminating null wide character, or \-1
68if an invalid multibyte character was encountered.
69.Sh ERRORS
70The
71.Fn mbstowcs
72function will fail if:
73.Bl -tag -width Er
58into a wide character string
59.Fa wcstring .
60No more than
61.Fa nwchars
62wide characters are stored.
63A terminating null wide character is appended if there is room.
64.Sh RETURN VALUES
65The
66.Fn mbstowcs
67function returns the number of wide characters converted,
68not counting any terminating null wide character, or \-1
69if an invalid multibyte character was encountered.
70.Sh ERRORS
71The
72.Fn mbstowcs
73function will fail if:
74.Bl -tag -width Er
74.\".It Bq Er EINVAL
75.\"Invalid argument.
76.It Bq Er EILSEQ
77An invalid multibyte sequence was detected.
75.It Bq Er EILSEQ
76An invalid multibyte sequence was detected.
77.It Bq Er EINVAL
78The conversion state is invalid.
78.El
79.Sh SEE ALSO
80.Xr mbtowc 3 ,
79.El
80.Sh SEE ALSO
81.Xr mbtowc 3 ,
81.Xr mbsrtowcs 3
82.Xr mbsrtowcs 3 ,
83.Xr multibyte 3
82.Sh STANDARDS
83The
84.Fn mbstowcs
85function conforms to
84.Sh STANDARDS
85The
86.Fn mbstowcs
87function conforms to
86.St -isoC .
87.Sh BUGS
88The current implementation does not support shift states.
88.St -isoC-99 .