xref: /freebsd/lib/libc/locale/mbsinit.3 (revision d3d381b2b194b4d24853e92eecef55f262688d1a)
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.\" $FreeBSD$
26.\"
27.Dd April 8, 2004
28.Dt MBSINIT 3
29.Os
30.Sh NAME
31.Nm mbsinit
32.Nd "determine conversion object status"
33.Sh LIBRARY
34.Lb libc
35.Sh SYNOPSIS
36.In wchar.h
37.Ft int
38.Fn mbsinit "const mbstate_t *ps"
39.Sh DESCRIPTION
40The
41.Fn mbsinit
42function determines whether the
43.Vt mbstate_t
44object pointed to by
45.Fa ps
46describes an initial conversion state.
47.Sh RETURN VALUES
48The
49.Fn mbsinit
50function returns non-zero if
51.Fa ps
52is
53.Dv NULL
54or describes an initial conversion state,
55otherwise it returns zero.
56.Sh SEE ALSO
57.Xr mbrlen 3 ,
58.Xr mbrtowc 3 ,
59.Xr mbsrtowcs 3 ,
60.Xr multibyte 3 ,
61.Xr wcrtomb 3 ,
62.Xr wcsrtombs 3
63.Sh STANDARDS
64The
65.Fn mbsinit
66function conforms to
67.St -isoC-99 .
68