bc0b3a1800
Instead of just deleting it, turn the original page into a general overview of the multibyte character conversion functions, somewhat similar to stdio(3).
91 lines
3.2 KiB
Groff
91 lines
3.2 KiB
Groff
.\" Copyright (c) 2002, 2003 Tim J. Robbins. All rights reserved.
|
|
.\" 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.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" 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$
|
|
.\"
|
|
.Dd November 19, 2003
|
|
.Dt WCSTOMBS 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm wcstombs ,
|
|
.Nd convert a wide-character string to a character string
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In stdlib.h
|
|
.Ft size_t
|
|
.Fn wcstombs "char * restrict mbstring" "const wchar_t * restrict wcstring" "size_t nbytes"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn wcstombs
|
|
function converts a wide character string
|
|
.Fa wcstring
|
|
into a multibyte character string
|
|
.Fa mbstring .
|
|
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
|
|
.Fn wcstombs
|
|
function returns the number of bytes converted,
|
|
not counting any terminating null byte, or \-1
|
|
if an invalid multibyte character was encountered.
|
|
.Sh ERRORS
|
|
The
|
|
.Fn wcstombs
|
|
function will fail if:
|
|
.Bl -tag -width Er
|
|
.\".It Bq Er EINVAL
|
|
.\"Invalid argument.
|
|
.It Bq Er EILSEQ
|
|
An invalid multibyte sequence was detected.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr mbstowcs 3 ,
|
|
.Xr wcsrtombs 3 ,
|
|
.Xr wctomb 3
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn wcstombs
|
|
function conforms to
|
|
.St -isoC .
|
|
.Sh BUGS
|
|
The current implementation does not support shift states.
|