1.\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved. 2.\" Copyright (c) 1993 3.\" The Regents of the University of California. All rights reserved. 4.\" 5.\" This code is derived from software contributed to Berkeley by 6.\" Donn Seeley of BSDI. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. All advertising materials mentioning features or use of this software 17.\" must display the following acknowledgement: 18.\" This product includes software developed by the University of 19.\" California, Berkeley and its contributors. 20.\" 4. Neither the name of the University nor the names of its contributors 21.\" may be used to endorse or promote products derived from this software 22.\" without specific prior written permission. 23.\" 24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34.\" SUCH DAMAGE. 35.\" 36.\" From @(#)multibyte.3 8.1 (Berkeley) 6/4/93 37.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp 38.\" $FreeBSD$ 39.\" 40.Dd April 11, 2004 41.Dt MBLEN 3 42.Os 43.Sh NAME 44.Nm mblen 45.Nd get number of bytes in a character 46.Sh LIBRARY 47.Lb libc 48.Sh SYNOPSIS 49.In stdlib.h 50.Ft int 51.Fn mblen "const char *mbchar" "size_t nbytes" 52.Sh DESCRIPTION 53The 54.Fn mblen 55function computes the length in bytes 56of a multibyte character 57.Fa mbchar 58according to the current conversion state. 59Up to 60.Fa nbytes 61bytes are examined. 62.Pp 63A call with a null 64.Fa mbchar 65pointer returns nonzero if the current locale requires shift states, 66zero otherwise; 67if shift states are required, the shift state is reset to the initial state. 68.Sh RETURN VALUES 69If 70.Fa mbchar 71is 72.Dv NULL , 73the 74.Fn mblen 75function returns nonzero if shift states are supported, 76zero otherwise. 77.Pp 78Otherwise, if 79.Fa mbchar 80is not a null pointer, 81.Fn mblen 82either returns 0 if 83.Fa mbchar 84represents the null wide character, or returns 85the number of bytes processed in 86.Fa mbchar , 87or returns \-1 if no multibyte character 88could be recognized or converted. 89In this case, 90.Fn mblen Ns 's 91internal conversion state is undefined. 92.Sh ERRORS 93The 94.Fn mblen 95function will fail if: 96.Bl -tag -width Er 97.It Bq Er EILSEQ 98An invalid multibyte sequence was detected. 99.It Bq Er EINVAL 100The internal conversion state is not valid. 101.El 102.Sh SEE ALSO 103.Xr mbrlen 3 , 104.Xr mbtowc 3 , 105.Xr multibyte 3 106.Sh STANDARDS 107The 108.Fn mblen 109function conforms to 110.St -isoC-99 . 111