1 .\" $NetBSD: src/lib/libc/locale/mbstowcs.3,v 1.8 2004/01/24 16:58:54 wiz Exp $
2 .\" $DragonFly: src/lib/libc/locale/mbstowcs.3,v 1.1 2005/03/12 00:18:01 joerg Exp $
4 .\" Copyright (c)2002 Citrus Project,
5 .\" All rights reserved.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" ----------------------------------------------------------------------
34 .Nd converts a multibyte character string to a wide character string
35 .\" ----------------------------------------------------------------------
38 .\" ----------------------------------------------------------------------
42 .Fn mbstowcs "wchar_t * restrict pwcs" "const char * restrict s" "size_t n"
43 .\" ----------------------------------------------------------------------
46 converts a null-terminated multibyte character string pointed to by
48 to the corresponding wide character string and stores it in the array
51 This function may modify the first at most
53 elements of the array pointed to by
55 Each character will be converted as if
57 is continuously called, except the internal state of
61 For state-dependent encoding,
63 implies the multibyte character string pointed to by
65 always begins with an initial state.
67 These are the special cases:
68 .Bl -tag -width 012345678901
71 returns the number of elements to store the whole wide character string
72 corresponding to the multibyte character string pointed to by
78 Undefined (may cause the program to crash).
80 .\" ----------------------------------------------------------------------
84 .Bl -tag -width 012345678901
86 Number of elements stored in the array pointed to by
88 There are no cases that the value returned is greater than
92 is a null pointer) or the value of the
95 If the return value is equal to
97 the string pointed to by
99 will not be null-terminated.
102 points to a string containing an invalid or incomplete multibyte character.
107 to indicate the error.
109 .\" ----------------------------------------------------------------------
112 may cause an error in the following case:
116 points to a string containing an invalid or incomplete multibyte character.
118 .\" ----------------------------------------------------------------------
122 .\" ----------------------------------------------------------------------
128 The restrict qualifier is added at