2006-10-16 12:42:16 +04:00
|
|
|
.\" $NetBSD: mbsinit.3,v 1.6 2006/10/16 08:42:16 wiz Exp $
|
2002-03-18 09:00:26 +03:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c)2002 Citrus Project,
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
2002-03-18 10:56:28 +03:00
|
|
|
.Dd February 3, 2002
|
2002-03-18 09:00:26 +03:00
|
|
|
.Dt MBSINIT 3
|
|
|
|
|
.Os
|
|
|
|
|
.\" ----------------------------------------------------------------------
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm mbsinit
|
2004-01-24 19:58:54 +03:00
|
|
|
.Nd determines whether the state object is in the initial state
|
2002-03-18 09:00:26 +03:00
|
|
|
.\" ----------------------------------------------------------------------
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
|
|
|
|
.Sh SYNOPSIS
|
2003-04-16 17:34:34 +04:00
|
|
|
.In wchar.h
|
2002-03-18 09:00:26 +03:00
|
|
|
.Ft int
|
|
|
|
|
.Fn mbsinit "const mbstate_t *ps"
|
|
|
|
|
.\" ----------------------------------------------------------------------
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn mbsinit
|
2004-01-24 19:58:54 +03:00
|
|
|
determines whether the state object pointed to by
|
2002-03-18 09:00:26 +03:00
|
|
|
.Fa ps
|
2004-01-24 19:58:54 +03:00
|
|
|
is the initial conversion state, or not.
|
2002-03-18 09:00:26 +03:00
|
|
|
.Pp
|
|
|
|
|
.Fa ps
|
2006-10-16 12:42:16 +04:00
|
|
|
may be a null pointer.
|
2002-10-01 21:02:56 +04:00
|
|
|
In this case,
|
2002-03-18 09:00:26 +03:00
|
|
|
.Fn mbsinit
|
|
|
|
|
will always return non-zero.
|
|
|
|
|
.\" ----------------------------------------------------------------------
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
.Fn mbsinit
|
|
|
|
|
returns:
|
|
|
|
|
.Bl -tag -width 0123456789
|
|
|
|
|
.It 0
|
2004-01-24 19:58:54 +03:00
|
|
|
The current state is not the initial state.
|
2002-03-18 09:00:26 +03:00
|
|
|
.It non-zero
|
2004-01-24 19:58:54 +03:00
|
|
|
The current state is the initial state or
|
2002-03-18 09:00:26 +03:00
|
|
|
.Fa ps
|
2006-10-16 12:42:16 +04:00
|
|
|
is a null pointer.
|
2002-03-18 09:00:26 +03:00
|
|
|
.El
|
|
|
|
|
.\" ----------------------------------------------------------------------
|
|
|
|
|
.Sh ERRORS
|
|
|
|
|
No errors are defined.
|
|
|
|
|
.\" ----------------------------------------------------------------------
|
|
|
|
|
.Sh STANDARDS
|
|
|
|
|
The
|
|
|
|
|
.Fn mbsinit
|
|
|
|
|
conforms to
|
|
|
|
|
.St -isoC-amd1 .
|
