1 .\" $NetBSD: src/lib/libc/locale/wctomb.3,v 1.4 2004/01/24 16:58:54 wiz Exp $
2 .\" $DragonFly: src/lib/libc/locale/wctomb.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
33 .Nd converts a wide character to a multibyte character
39 .Fn wctomb "char * s" "const wchar_t wchar"
43 converts the wide character
45 to the corresponding multibyte character, and stores it in the array
53 In state-dependent encoding,
55 may store the special sequence to change the conversion state
56 before an actual multibyte character into the array pointed to by
60 is a null wide character
62 this function sets its own internal state to an initial conversion state.
64 Calling any other functions in
66 never changes the internal state of
70 category of the current locale by calling
74 calls cause the internal state of this function to be indeterminate.
80 category of the current locale.
82 There is one special case:
83 .Bl -tag -width 012345678901
86 initializes its own internal state to an initial state, and
87 determines whether the current encoding is state-dependent.
88 This function returns 0 if the encoding is state-independent,
92 is completely ignored.
98 .Bl -tag -width 012345678901
100 Number of bytes for the valid multibyte character pointed to by
102 There are no cases that the value returned is greater than
109 is an invalid wide character.
118 .Bl -tag -width 0123456789
120 The current encoding is state-independent.
122 The current encoding is state-dependent.
125 No errors are defined.