summaryrefslogtreecommitdiffstats
path: root/man3/wcrtomb.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/wcrtomb.3')
-rw-r--r--man3/wcrtomb.3147
1 files changed, 0 insertions, 147 deletions
diff --git a/man3/wcrtomb.3 b/man3/wcrtomb.3
deleted file mode 100644
index 2f1df9a02..000000000
--- a/man3/wcrtomb.3
+++ /dev/null
@@ -1,147 +0,0 @@
-'\" t
-.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
-.\"
-.\" SPDX-License-Identifier: GPL-2.0-or-later
-.\"
-.\" 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 wcrtomb 3 (date) "Linux man-pages (unreleased)"
-.SH NAME
-wcrtomb \- convert a wide character to a multibyte sequence
-.SH LIBRARY
-Standard C library
-.RI ( libc ", " \-lc )
-.SH SYNOPSIS
-.nf
-.B #include <wchar.h>
-.PP
-.BI "size_t wcrtomb(char *restrict " s ", wchar_t " wc \
-", mbstate_t *restrict " ps );
-.fi
-.SH DESCRIPTION
-The main case for this function is when
-.I s
-is
-not NULL and
-.I wc
-is not a null wide character (L\[aq]\e0\[aq]).
-In this case, the
-.BR wcrtomb ()
-function
-converts the wide character
-.I wc
-to its multibyte representation and stores it
-at the beginning of the character
-array pointed to by
-.IR s .
-It updates the shift state
-.IR *ps ,
-and
-returns the length of said multibyte representation,
-that is, the number of bytes
-written at
-.IR s .
-.PP
-A different case is when
-.I s
-is not NULL,
-but
-.I wc
-is a null wide character (L\[aq]\e0\[aq]).
-In this case, the
-.BR wcrtomb ()
-function stores at
-the character array pointed to by
-.I s
-the shift sequence needed to
-bring
-.I *ps
-back to the initial state,
-followed by a \[aq]\e0\[aq] byte.
-It updates the shift state
-.I *ps
-(i.e., brings
-it into the initial state),
-and returns the length of the shift sequence plus
-one, that is, the number of bytes written at
-.IR s .
-.PP
-A third case is when
-.I s
-is NULL.
-In this case,
-.I wc
-is ignored,
-and the function effectively returns
-.PP
-.in +4n
-.EX
-wcrtomb(buf, L\[aq]\e0\[aq], ps)
-.EE
-.in
-.PP
-where
-.I buf
-is an internal anonymous buffer.
-.PP
-In all of the above cases, if
-.I ps
-is NULL, a static anonymous
-state known only to the
-.BR wcrtomb ()
-function is used instead.
-.SH RETURN VALUE
-The
-.BR wcrtomb ()
-function returns the number of
-bytes that have been or would
-have been written to the byte array at
-.IR s .
-If
-.I wc
-can not be
-represented as a multibyte sequence (according to the current locale),
-.I (size_t)\ \-1
-is returned, and
-.I errno
-set to
-.BR EILSEQ .
-.SH ATTRIBUTES
-For an explanation of the terms used in this section, see
-.BR attributes (7).
-.ad l
-.nh
-.TS
-allbox;
-lbx lb lb
-l l l.
-Interface Attribute Value
-T{
-.BR wcrtomb ()
-T} Thread safety MT-Unsafe race:wcrtomb/!ps
-.TE
-.hy
-.ad
-.sp 1
-.SH STANDARDS
-C11, POSIX.1-2008.
-.SH HISTORY
-POSIX.1-2001, C99.
-.SH NOTES
-The behavior of
-.BR wcrtomb ()
-depends on the
-.B LC_CTYPE
-category of the
-current locale.
-.PP
-Passing NULL as
-.I ps
-is not multithread safe.
-.SH SEE ALSO
-.BR mbsinit (3),
-.BR wcsrtombs (3)