lib/libc/locale/mbsinit.3

   1 .\" Copyright (c) 2002-2004 Tim J. Robbins
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: head/lib/libc/locale/mbsinit.3 128032 2004-04-08 09:59:02Z tjr $
  26 .\"
  27 .Dd December 26, 2013
  28 .Dt MBSINIT 3
  29 .Os
  30 .Sh NAME
  31 .Nm mbsinit ,
  32 .Nm mbsinit_l
  33 .Nd "determine conversion object status"
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In wchar.h
  38 .Ft int
  39 .Fn mbsinit "const mbstate_t *ps"
  40 .In xlocale.h
  41 .Ft int
  42 .Fn mbsinit_l "const mbstate_t *ps" "locale_t locale"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn mbsinit
  46 and
  47 .Fn mbsinit_l
  48 functions determine whether the
  49 .Vt mbstate_t
  50 object pointed to by
  51 .Fa ps
  52 describes an initial conversion state.
  53 .Pp
  54 The
  55 .Fn mbsinit_l
  56 function takes an explicit
  57 .Fa locale
  58 argument, whereas the
  59 .Fn mbsinit
  60 function uses the current global or per-thread locale.
  61 .Sh RETURN VALUES
  62 The
  63 .Fn mbsinit
  64 and
  65 .Fn mbsinit_l
  66 functions return non-zero if
  67 .Fa ps
  68 is
  69 .Dv NULL
  70 or describes an initial conversion state,
  71 otherwise it returns zero.
  72 .Sh SEE ALSO
  73 .Xr mbrlen 3 ,
  74 .Xr mbrtowc 3 ,
  75 .Xr mbsrtowcs 3 ,
  76 .Xr multibyte 3 ,
  77 .Xr wcrtomb 3 ,
  78 .Xr wcsrtombs 3 ,
  79 .Xr xlocale 3
  80 .Sh STANDARDS
  81 The
  82 .Fn mbsinit
  83 function conforms to
  84 .St -isoC-99 .