xref: /freebsd/lib/libc/locale/mbsinit.3 (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1.\" Copyright (c) 2002-2004 Tim J. Robbins
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
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.
12.\"
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
23.\" SUCH DAMAGE.
24.\"
25.Dd April 8, 2004
26.Dt MBSINIT 3
27.Os
28.Sh NAME
29.Nm mbsinit
30.Nd "determine conversion object status"
31.Sh LIBRARY
32.Lb libc
33.Sh SYNOPSIS
34.In wchar.h
35.Ft int
36.Fn mbsinit "const mbstate_t *ps"
37.Sh DESCRIPTION
38The
39.Fn mbsinit
40function determines whether the
41.Vt mbstate_t
42object pointed to by
43.Fa ps
44describes an initial conversion state.
45.Sh RETURN VALUES
46The
47.Fn mbsinit
48function returns non-zero if
49.Fa ps
50is
51.Dv NULL
52or describes an initial conversion state,
53otherwise it returns zero.
54.Sh SEE ALSO
55.Xr mbrlen 3 ,
56.Xr mbrtowc 3 ,
57.Xr mbsrtowcs 3 ,
58.Xr multibyte 3 ,
59.Xr wcrtomb 3 ,
60.Xr wcsrtombs 3
61.Sh STANDARDS
62The
63.Fn mbsinit
64function conforms to
65.St -isoC-99 .
66