d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8d55975f92
freebsd-skq/lib/libc/locale/mblen.3

107 lines
3.2 KiB
Groff
Raw Normal View History

Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
.\" Copyright (c) 2002-2004 Tim J. Robbins. All rights reserved.
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.\" Copyright (c) 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Donn Seeley of BSDI.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
.\" 3. Neither the name of the University nor the names of its contributors
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" From @(#)multibyte.3 8.1 (Berkeley) 6/4/93
.\" From FreeBSD: src/lib/libc/locale/multibyte.3,v 1.22 2003/11/08 03:23:11 tjr Exp
.\" $FreeBSD$
.\"
Document the meaning of the zero return value.
2004-04-11 05:19:19 +00:00
.Dd April 11, 2004
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.Dt MBLEN 3
.Os
.Sh NAME
.Nm mblen
.Nd get number of bytes in a character
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft int
.Fn mblen "const char *mbchar" "size_t nbytes"
.Sh DESCRIPTION
The
.Fn mblen
function computes the length in bytes
of a multibyte character
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
.Fa mbchar
according to the current conversion state.
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
Up to
.Fa nbytes
bytes are examined.
.Pp
A call with a null
.Fa mbchar
pointer returns nonzero if the current locale requires shift states,
zero otherwise;
if shift states are required, the shift state is reset to the initial state.
.Sh RETURN VALUES
If
.Fa mbchar
is
.Dv NULL ,
the
.Fn mblen
function returns nonzero if shift states are supported,
zero otherwise.
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
.Pp
Otherwise, if
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.Fa mbchar
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
is not a null pointer,
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.Fn mblen
Document the meaning of the zero return value.
2004-04-11 05:19:19 +00:00
either returns 0 if
.Fa mbchar
represents the null wide character, or returns
the number of bytes processed in
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.Fa mbchar ,
Document the meaning of the zero return value.
2004-04-11 05:19:19 +00:00
or returns \-1 if no multibyte character
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
could be recognized or converted.
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
In this case,
Markup nits.
2004-07-05 06:39:03 +00:00
.Fn mblen Ns 's
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
internal conversion state is undefined.
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.Sh ERRORS
Removed trailing whitespace.
2004-07-02 19:07:33 +00:00
The
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.Fn mblen
function will fail if:
.Bl -tag -width Er
.It Bq Er EILSEQ
An invalid multibyte sequence was detected.
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
.It Bq Er EINVAL
The internal conversion state is not valid.
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.El
.Sh SEE ALSO
.Xr mbrlen 3 ,
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
.Xr mbtowc 3 ,
.Xr multibyte 3
Split multibyte(3) into separate manual pages for each function. Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
2003-12-07 06:33:52 +00:00
.Sh STANDARDS
The
.Fn mblen
function conforms to
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
.St -isoC-99 .
Reference in New Issue Copy Permalink