1.\" $OpenBSD: mbsinit.3,v 1.2 2007/05/31 19:19:29 jmc Exp $ 2.\" $NetBSD: mbsinit.3,v 1.4 2003/04/16 13:34:40 wiz Exp $ 3.\" 4.\" Copyright (c)2002 Citrus Project, 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 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. 15.\" 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 26.\" SUCH DAMAGE. 27.\" 28.Dd $Mdocdate: May 31 2007 $ 29.Dt MBSINIT 3 30.Os 31.\" ---------------------------------------------------------------------- 32.Sh NAME 33.Nm mbsinit 34.Nd determines whether the state object is in initial state 35.\" ---------------------------------------------------------------------- 36.Sh SYNOPSIS 37.Fd #include <wchar.h> 38.Ft int 39.Fn mbsinit "const mbstate_t *ps" 40.\" ---------------------------------------------------------------------- 41.Sh DESCRIPTION 42.Fn mbsinit 43determines whether the state object pointed to by 44.Fa ps 45is in initial conversion state, or not. 46.Pp 47.Fa ps 48may be a 49.Dv NULL 50pointer. 51In this case, 52.Fn mbsinit 53will always return non-zero. 54.\" ---------------------------------------------------------------------- 55.Sh RETURN VALUES 56.Fn mbsinit 57returns: 58.Bl -tag -width 0123456789 59.It 0 60The current state is not in initial state. 61.It non-zero 62The current state is in initial state or 63.Fa ps 64is a 65.Dv NULL 66pointer. 67.El 68.\" ---------------------------------------------------------------------- 69.Sh ERRORS 70No errors are defined. 71.\" ---------------------------------------------------------------------- 72.Sh STANDARDS 73The 74.Fn mbsinit 75conforms to 76.\" .St -isoC-amd1 . 77ISO/IEC 9899/AMD1:1995 78.Pq Dq ISO C90, Amendment 1 . 79