pd.if.org Git - pdclib.old/blob - man3/mbsinit.3

   1 .\" This file is part of the Public Domain C Library (PDCLib).\r
   2 .\" Permission is granted to use, modify, and / or redistribute at will.\r
   3 .\"\r
   4 .Dd\r
   5 .Dt MBSINIT 3\r
   6 .Os\r
   7 .\"\r
   8 .Sh NAME\r
   9 .Nm mbsinit\r
  10 .Nd determines multibyte conversion state\r
  11 .\"\r
  12 .Sh SYNOPSIS\r
  13 .In wchar.h\r
  14 .Fn "int mbsinit" "const mbstate_t *ps"\r
  15 .In xlocale.h\r
  16 .Fn "int mbsinit_l" "const mbstate_t *ps" "locale_t loc"\r
  17 .\"\r
  18 .Sh DESCRIPTION\r
  19 .Fn mbsinit \r
  20 and\r
  21 .Fn mbsinit_l \r
  22 shall return a nonzero value if the multibyte converison state pointed to by\r
  23 .Va ps\r
  24 corresponds to an initial conversion state. The interpretation of \r
  25 .Va *ps\r
  26 is locale dependent; the only guarantee is that an\r
  27 .Vt mbstate_t\r
  28 object initialized to zero shall correspond to an initial conversion state. If\r
  29 .Va ps\r
  30 is\r
  31 .Dv NULL ,\r
  32 then a nonzero value shall be returned.\r
  33 .\"\r
  34 .Pp\r
  35 The locale used for \r
  36 .Fn mbsinit\r
  37 shall be the currently active locale; either the current thread locale as set by\r
  38 .Xr uselocale 3\r
  39 if one has been specified, or otherwise the global locale controlled by\r
  40 .Xr setlocale 3 .\r
  41 The locale used by \r
  42 .Fn mbsinit_l\r
  43 is that specified by\r
  44 .Va loc .\r
  45 .\"\r
  46 .Sh SEE ALSO\r
  47 .Xr mbrtowc 3\r
  48 .Xr wcrtomb 3\r
  49 .Xr setlocale 3\r
  50 .Xr uselocale 3\r
  51 .\"\r
  52 .Sh STANDARDS\r
  53 .Fn mbsinit\r
  54 is first defined in\r
  55 .St -isoC-amd1 ;\r
  56 .Fn mbsinit_l\r
  57 is a nonstandard extension originating in Darwin. See\r
  58 .Xr xlocale.h 3