1 .\" Copyright (c) 2002-2004 Tim J. Robbins
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: head/lib/libc/locale/wcrtomb.3 250883 2013-05-21 19:59:37Z ed $
37 .Nd "convert a wide-character code to a character (restartable)"
43 .Fn wcrtomb "char * restrict s" "wchar_t c" "mbstate_t * restrict ps"
46 .Fn c16rtomb "char * restrict s" "char16_t c" "mbstate_t * restrict ps"
48 .Fn c32rtomb "char * restrict s" "char32_t c" "mbstate_t * restrict ps"
51 .Fn wcrtomb_l "char * restrict s" "wchar_t c" "mbstate_t * restrict ps" "locale_t locale"
53 .Fn c16rtomb_l "char * restrict s" "char16_t c" "mbstate_t * restrict ps" "locale_t locale"
55 .Fn c32rtomb_l "char * restrict s" "char32_t c" "mbstate_t * restrict ps" "locale_t"
65 functions store a multibyte sequence representing the
68 including any necessary shift sequences, to the
79 these functions behave as if
81 pointed to an internal buffer and
83 was a null wide character (L'\e0').
89 is used to keep track of the shift state.
92 these functions use an internal, static
94 object, which is initialized to the initial conversion state
97 As certain multibyte characters may only be represented by a series of
98 16-bit characters, the
100 may need to invoked multiple times before a multibyte sequence is
108 functions take an explicit
110 argument, whereas the
115 functions use the current global or per-thread locale.
117 These functions return the length (in bytes) of the multibyte sequence
121 .Po Vt size_t Pc Ns \-1
124 is not a valid wide character code.
134 functions will fail if:
137 An invalid wide character code was specified.
139 The conversion state is invalid.