xref: /netbsd-src/lib/libc/locale/mbsinit.3 (revision aba3ac5c7320e086e8a7d48af9503e42a516b69e)
1*aba3ac5cSwiz.\" $NetBSD: mbsinit.3,v 1.6 2006/10/16 08:42:16 wiz Exp $
28625ada8Stshiozak.\"
38625ada8Stshiozak.\" Copyright (c)2002 Citrus Project,
48625ada8Stshiozak.\" All rights reserved.
58625ada8Stshiozak.\"
68625ada8Stshiozak.\" Redistribution and use in source and binary forms, with or without
78625ada8Stshiozak.\" modification, are permitted provided that the following conditions
88625ada8Stshiozak.\" are met:
98625ada8Stshiozak.\" 1. Redistributions of source code must retain the above copyright
108625ada8Stshiozak.\"    notice, this list of conditions and the following disclaimer.
118625ada8Stshiozak.\" 2. Redistributions in binary form must reproduce the above copyright
128625ada8Stshiozak.\"    notice, this list of conditions and the following disclaimer in the
138625ada8Stshiozak.\"    documentation and/or other materials provided with the distribution.
148625ada8Stshiozak.\"
158625ada8Stshiozak.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
168625ada8Stshiozak.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
178625ada8Stshiozak.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
188625ada8Stshiozak.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
198625ada8Stshiozak.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
208625ada8Stshiozak.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
218625ada8Stshiozak.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
228625ada8Stshiozak.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
238625ada8Stshiozak.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
248625ada8Stshiozak.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
258625ada8Stshiozak.\" SUCH DAMAGE.
268625ada8Stshiozak.\"
279f64fab4Swiz.Dd February 3, 2002
288625ada8Stshiozak.Dt MBSINIT 3
298625ada8Stshiozak.Os
308625ada8Stshiozak.\" ----------------------------------------------------------------------
318625ada8Stshiozak.Sh NAME
328625ada8Stshiozak.Nm mbsinit
33cef0afe9Swiz.Nd determines whether the state object is in the initial state
348625ada8Stshiozak.\" ----------------------------------------------------------------------
358625ada8Stshiozak.Sh LIBRARY
368625ada8Stshiozak.Lb libc
378625ada8Stshiozak.Sh SYNOPSIS
38472351e1Swiz.In wchar.h
398625ada8Stshiozak.Ft int
408625ada8Stshiozak.Fn mbsinit "const mbstate_t *ps"
418625ada8Stshiozak.\" ----------------------------------------------------------------------
428625ada8Stshiozak.Sh DESCRIPTION
438625ada8StshiozakThe
448625ada8Stshiozak.Fn mbsinit
45cef0afe9Swizdetermines whether the state object pointed to by
468625ada8Stshiozak.Fa ps
47cef0afe9Swizis the initial conversion state, or not.
488625ada8Stshiozak.Pp
498625ada8Stshiozak.Fa ps
50*aba3ac5cSwizmay be a null pointer.
513225ede1SwizIn this case,
528625ada8Stshiozak.Fn mbsinit
538625ada8Stshiozakwill always return non-zero.
548625ada8Stshiozak.\" ----------------------------------------------------------------------
558625ada8Stshiozak.Sh RETURN VALUES
568625ada8Stshiozak.Fn mbsinit
578625ada8Stshiozakreturns:
588625ada8Stshiozak.Bl -tag -width 0123456789
598625ada8Stshiozak.It 0
60cef0afe9SwizThe current state is not the initial state.
618625ada8Stshiozak.It non-zero
62cef0afe9SwizThe current state is the initial state or
638625ada8Stshiozak.Fa ps
64*aba3ac5cSwizis a null pointer.
658625ada8Stshiozak.El
668625ada8Stshiozak.\" ----------------------------------------------------------------------
678625ada8Stshiozak.Sh ERRORS
688625ada8StshiozakNo errors are defined.
698625ada8Stshiozak.\" ----------------------------------------------------------------------
708625ada8Stshiozak.Sh STANDARDS
718625ada8StshiozakThe
728625ada8Stshiozak.Fn mbsinit
738625ada8Stshiozakconforms to
748625ada8Stshiozak.St -isoC-amd1 .
75