2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
|
|
.\"
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
.\"
|
|
|
|
.\" References consulted:
|
|
|
|
.\" GNU glibc-2 source code and manual
|
|
|
|
.\" Dinkumware C library reference http://www.dinkumware.com/
|
|
|
|
.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
|
|
|
|
.\" ISO/IEC 9899:1999
|
|
|
|
.\"
|
|
|
|
.TH WCTOMB 3 1999-07-25 "GNU" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
|
|
|
wctomb \- convert a wide character to a multibyte sequence
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <stdlib.h>
|
|
|
|
.sp
|
|
|
|
.BI "int wctomb(char *" s ", wchar_t " wc );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2005-10-19 06:54:38 +00:00
|
|
|
If \fIs\fP is not NULL, the \fBwctomb\fP() function converts the wide character
|
2004-11-03 13:51:07 +00:00
|
|
|
\fIwc\fP to its multibyte representation and stores it at the beginning of
|
|
|
|
the character array pointed to by \fIs\fP. It updates the shift state, which
|
|
|
|
is stored in a static anonymous variable only known to the wctomb function,
|
|
|
|
and returns the length of said multibyte representation, i.e. the number of
|
|
|
|
bytes written at \fIs\fP.
|
|
|
|
.PP
|
|
|
|
The programmer must ensure that there is room for at least \fBMB_CUR_MAX\fP
|
|
|
|
bytes at \fIs\fP.
|
|
|
|
.PP
|
2005-10-19 06:54:38 +00:00
|
|
|
If \fIs\fP is NULL, the \fBwctomb\fP() function
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" The Dinkumware doc and the Single Unix specification say this, but
|
|
|
|
.\" glibc doesn't implement this.
|
|
|
|
resets the shift state, only known to this function, to the initial state, and
|
|
|
|
returns non-zero if the encoding has non-trivial shift state, or zero if the
|
|
|
|
encoding is stateless.
|
|
|
|
.SH "RETURN VALUE"
|
2005-10-19 06:54:38 +00:00
|
|
|
If \fIs\fP is not NULL, the \fBwctomb\fP() function returns the number of bytes
|
2004-11-03 13:51:07 +00:00
|
|
|
that have been written to the byte array at \fIs\fP. If \fIwc\fP can not be
|
|
|
|
represented as a multibyte sequence (according to the current locale), \-1 is
|
|
|
|
returned.
|
|
|
|
.PP
|
2005-10-19 06:54:38 +00:00
|
|
|
If \fIs\fP is NULL, the \fBwctomb\fP() function returns non-zero if the
|
2004-11-03 13:51:07 +00:00
|
|
|
encoding has non-trivial shift state, or zero if the encoding is stateless.
|
|
|
|
.SH "CONFORMING TO"
|
|
|
|
ISO/ANSI C, UNIX98
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR MB_CUR_MAX (3),
|
|
|
|
.BR wcrtomb (3),
|
|
|
|
.BR wcstombs (3)
|
|
|
|
.SH NOTES
|
2005-10-19 06:54:38 +00:00
|
|
|
The behaviour of \fBwctomb\fP() depends on the LC_CTYPE category of the
|
2004-11-03 13:51:07 +00:00
|
|
|
current locale.
|
|
|
|
.PP
|
2005-10-19 08:35:30 +00:00
|
|
|
This function is not multi-thread safe. The function \fBwcrtomb\fP() provides
|
2004-11-03 13:51:07 +00:00
|
|
|
a better interface to the same functionality.
|