1.\" $NetBSD: mbsinit.3,v 1.3 2002/10/01 17:02:57 wiz Exp $ 2.\" 3.\" Copyright (c)2002 Citrus Project, 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.Dd February 3, 2002 28.Dt MBSINIT 3 29.Os 30.\" ---------------------------------------------------------------------- 31.Sh NAME 32.Nm mbsinit 33.Nd determines whether the state object is initial state 34.\" ---------------------------------------------------------------------- 35.Sh LIBRARY 36.Lb libc 37.Sh SYNOPSIS 38.Fd #include \*[Lt]wchar.h\*[Gt] 39.Ft int 40.Fn mbsinit "const mbstate_t *ps" 41.\" ---------------------------------------------------------------------- 42.Sh DESCRIPTION 43The 44.Fn mbsinit 45determines whether the state object pointed by 46.Fa ps 47is initial conversion state, or not. 48.Pp 49.Fa ps 50may be NULL pointer. 51In this case, 52.Fn mbsinit 53will always return non-zero. 54.\" ---------------------------------------------------------------------- 55.Sh RETURN VALUES 56The 57.Fn mbsinit 58returns: 59.Bl -tag -width 0123456789 60.It 0 61The current state is not initial state. 62.It non-zero 63The current state is initial state or 64.Fa ps 65is NULL pointer. 66.El 67.\" ---------------------------------------------------------------------- 68.Sh ERRORS 69No errors are defined. 70.\" ---------------------------------------------------------------------- 71.Sh STANDARDS 72The 73.Fn mbsinit 74conforms to 75.St -isoC-amd1 . 76