projects / apple / libc.git / blame
| Commit | Line | Data |
|---|---|---|
| 224c7076 A |
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: src/lib/libc/locale/mbsinit.3,v 1.3 2004/04/08 09:59:02 tjr Exp $ | |
| 26 | .\" | |
| 27 | .Dd April 8, 2004 | |
| 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 wchar.h | |
| 41 | .In xlocale.h | |
| 42 | .Ft int | |
| 43 | .Fn mbsinit_l "const mbstate_t *ps" "locale_t loc" | |
| 44 | .Sh DESCRIPTION | |
| 45 | The | |
| 46 | .Fn mbsinit | |
| 47 | function determines whether the | |
| 48 | .Vt mbstate_t | |
| 49 | object pointed to by | |
| 50 | .Fa ps | |
| 51 | describes an initial conversion state. | |
| 52 | .Pp | |
| 53 | While the | |
| 54 | .Fn mbsinit | |
| 55 | function uses the current locale, the | |
| 56 | .Fn mbsinit_l | |
| 57 | function may be passed a locale directly. See | |
| 58 | .Xr xlocale 3 | |
| 59 | for more information. | |
| 60 | .Sh RETURN VALUES | |
| 61 | The | |
| 62 | .Fn mbsinit | |
| 63 | function returns non-zero if | |
| 64 | .Fa ps | |
| 65 | is | |
| 66 | .Dv NULL | |
| 67 | or describes an initial conversion state; | |
| 68 | otherwise, it returns zero. | |
| 69 | .Sh SEE ALSO | |
| 70 | .Xr mbrlen 3 , | |
| 71 | .Xr mbrtowc 3 , | |
| 72 | .Xr mbsrtowcs 3 , | |
| 73 | .Xr multibyte 3 , | |
| 74 | .Xr wcrtomb 3 , | |
| 75 | .Xr wcsrtombs 3 , | |
| 76 | .Xr xlocale 3 | |
| 77 | .Sh STANDARDS | |
| 78 | The | |
| 79 | .Fn mbsinit | |
| 80 | function conforms to | |
| 81 | .St -isoC-99 . |