d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
5e84ba7a43
freebsd-dev/lib/libc/locale/wcstombs.3

91 lines
3.0 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$
.\"
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
.Dd April 8, 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 WCSTOMBS 3
.Os
.Sh NAME
Markup nits.
2004-07-05 06:39:03 +00:00
.Nm wcstombs
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
.Nd convert a wide-character string to a character string
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft size_t
Markup nits.
2004-07-05 06:39:03 +00:00
.Fo wcstombs
.Fa "char * restrict mbstring" "const wchar_t * restrict wcstring"
.Fa "size_t nbytes"
.Fc
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 DESCRIPTION
The
.Fn wcstombs
function converts a wide character string
.Fa wcstring
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
into a multibyte character string,
.Fa mbstring ,
beginning in the initial 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 stored in
.Fa mbstring .
Partial multibyte characters at the end of the string are not stored.
The multibyte character string is null terminated if there is room.
.Sh RETURN VALUES
Make consistent with the better written wcsrtombs function: - Fix syntax - Remove the (slightly wrong) duplicate explanation of the error condition - Change reference to invalid multibyte character into invalid wide character
2004-02-27 15:03:22 +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 wcstombs
Make consistent with the better written wcsrtombs function: - Fix syntax - Remove the (slightly wrong) duplicate explanation of the error condition - Change reference to invalid multibyte character into invalid wide character
2004-02-27 15:03:22 +00:00
function returns the number of bytes converted
(not including any terminating null), if successful, otherwise it returns
.Po Vt size_t Pc Ns \-1 .
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
The
.Fn wcstombs
function will fail if:
.Bl -tag -width Er
.It Bq Er EILSEQ
Make consistent with the better written wcsrtombs function: - Fix syntax - Remove the (slightly wrong) duplicate explanation of the error condition - Change reference to invalid multibyte character into invalid wide character
2004-02-27 15:03:22 +00:00
An invalid wide character was encountered.
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
.It Bq Er EINVAL
The conversion state is invalid.
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 mbstowcs 3 ,
Update manual pages for change to C99 mbrtowc() semantics.
2004-04-08 09:59:02 +00:00
.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
.Xr wcsrtombs 3 ,
.Xr wctomb 3
.Sh STANDARDS
The
.Fn wcstombs
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