lib/libc/locale/mbsinit.3

   1 .\" $NetBSD: src/lib/libc/locale/mbsinit.3,v 1.5 2004/01/24 16:58:54 wiz Exp $
   2 .\" $DragonFly: src/lib/libc/locale/mbsinit.3,v 1.1 2005/03/12 00:18:01 joerg 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 February 3, 2002
  29 .Dt MBSINIT 3
  30 .Os
  31 .\" ----------------------------------------------------------------------
  32 .Sh NAME
  33 .Nm mbsinit
  34 .Nd determines whether the state object is in the initial state
  35 .\" ----------------------------------------------------------------------
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In wchar.h
  40 .Ft int
  41 .Fn mbsinit "const mbstate_t *ps"
  42 .\" ----------------------------------------------------------------------
  43 .Sh DESCRIPTION
  44 The
  45 .Fn mbsinit
  46 determines whether the state object pointed to by
  47 .Fa ps
  48 is the initial conversion state, or not.
  49 .Pp
  50 .Fa ps
  51 may be a
  52 .Dv NULL
  53 pointer.
  54 In this case,
  55 .Fn mbsinit
  56 will always return non-zero.
  57 .\" ----------------------------------------------------------------------
  58 .Sh RETURN VALUES
  59 .Fn mbsinit
  60 returns:
  61 .Bl -tag -width 0123456789
  62 .It 0
  63 The current state is not the initial state.
  64 .It non-zero
  65 The current state is the initial state or
  66 .Fa ps
  67 is a
  68 .Dv NULL
  69 pointer.
  70 .El
  71 .\" ----------------------------------------------------------------------
  72 .Sh ERRORS
  73 No errors are defined.
  74 .\" ----------------------------------------------------------------------
  75 .Sh STANDARDS
  76 The
  77 .Fn mbsinit
  78 conforms to
  79 .St -isoC-amd1 .