|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH WCSRTOMBS "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
wcsnrtombs, wcsrtombs
|
|
Packit |
7cfc04 |
\(em convert a wide-character string to a character string (restartable)
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <wchar.h>
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
size_t wcsnrtombs(char *restrict \fIdst\fP, const wchar_t **restrict \fIsrc\fP,
|
|
Packit |
7cfc04 |
size_t \fInwc\fP, size_t \fIlen\fP, mbstate_t *restrict \fIps\fP);
|
|
Packit |
7cfc04 |
size_t wcsrtombs(char *restrict \fIdst\fP, const wchar_t **restrict \fIsrc\fP,
|
|
Packit |
7cfc04 |
size_t \fIlen\fP, mbstate_t *restrict \fIps\fP);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
For
|
|
Packit |
7cfc04 |
\fIwcsrtombs\fR():
|
|
Packit |
7cfc04 |
The functionality described on this reference page is aligned with the
|
|
Packit |
7cfc04 |
ISO\ C standard. Any conflict between the requirements described here and the
|
|
Packit |
7cfc04 |
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2008 defers to the ISO\ C standard.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIwcsrtombs\fR()
|
|
Packit |
7cfc04 |
function shall convert a sequence of wide characters from the array
|
|
Packit |
7cfc04 |
indirectly pointed to by
|
|
Packit |
7cfc04 |
.IR src
|
|
Packit |
7cfc04 |
into a sequence of corresponding characters, beginning in the
|
|
Packit |
7cfc04 |
conversion state described by the object pointed to by
|
|
Packit |
7cfc04 |
.IR ps .
|
|
Packit |
7cfc04 |
If
|
|
Packit |
7cfc04 |
.IR dst
|
|
Packit |
7cfc04 |
is not a null pointer, the converted characters shall then be
|
|
Packit |
7cfc04 |
stored into the array pointed to by
|
|
Packit |
7cfc04 |
.IR dst .
|
|
Packit |
7cfc04 |
Conversion continues up to and including a terminating null wide
|
|
Packit |
7cfc04 |
character, which shall also be stored. Conversion shall stop
|
|
Packit |
7cfc04 |
earlier in the following cases:
|
|
Packit |
7cfc04 |
.IP " *" 4
|
|
Packit |
7cfc04 |
When a code is reached that does not correspond to a valid character
|
|
Packit |
7cfc04 |
.IP " *" 4
|
|
Packit |
7cfc04 |
When the next character would exceed the limit of
|
|
Packit |
7cfc04 |
.IR len
|
|
Packit |
7cfc04 |
total bytes to be stored in the array pointed to by
|
|
Packit |
7cfc04 |
.IR dst
|
|
Packit |
7cfc04 |
(and
|
|
Packit |
7cfc04 |
.IR dst
|
|
Packit |
7cfc04 |
is not a null pointer)
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
Each conversion shall take place as if by a call to the
|
|
Packit |
7cfc04 |
\fIwcrtomb\fR()
|
|
Packit |
7cfc04 |
function.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
If
|
|
Packit |
7cfc04 |
.IR dst
|
|
Packit |
7cfc04 |
is not a null pointer, the pointer object pointed to by
|
|
Packit |
7cfc04 |
.IR src
|
|
Packit |
7cfc04 |
shall be assigned either a null pointer (if conversion stopped due to
|
|
Packit |
7cfc04 |
reaching a terminating null wide character) or the address just past
|
|
Packit |
7cfc04 |
the last wide character converted (if any). If conversion stopped due
|
|
Packit |
7cfc04 |
to reaching a terminating null wide character, the resulting state
|
|
Packit |
7cfc04 |
described shall be the initial conversion state.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
If
|
|
Packit |
7cfc04 |
.IR ps
|
|
Packit |
7cfc04 |
is a null pointer, the
|
|
Packit |
7cfc04 |
\fIwcsrtombs\fR()
|
|
Packit |
7cfc04 |
function shall use its own internal
|
|
Packit |
7cfc04 |
.BR mbstate_t
|
|
Packit |
7cfc04 |
object, which is initialized at program start-up to the initial
|
|
Packit |
7cfc04 |
conversion state. Otherwise, the
|
|
Packit |
7cfc04 |
.BR mbstate_t
|
|
Packit |
7cfc04 |
object pointed to by
|
|
Packit |
7cfc04 |
.IR ps
|
|
Packit |
7cfc04 |
shall be used to completely describe the current conversion state of
|
|
Packit |
7cfc04 |
the associated character sequence.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIwcsnrtombs\fR()
|
|
Packit |
7cfc04 |
and
|
|
Packit |
7cfc04 |
\fIwcsrtombs\fR()
|
|
Packit |
7cfc04 |
functions need not be thread-safe if called with a NULL
|
|
Packit |
7cfc04 |
.IR ps
|
|
Packit |
7cfc04 |
argument.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIwcsnrtombs\fR()
|
|
Packit |
7cfc04 |
function shall be equivalent to the
|
|
Packit |
7cfc04 |
\fIwcsrtombs\fR()
|
|
Packit |
7cfc04 |
function, except that the conversion is limited to the first
|
|
Packit |
7cfc04 |
.IR nwc
|
|
Packit |
7cfc04 |
wide characters.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIwcsrtombs\fR()
|
|
Packit |
7cfc04 |
function shall not change the setting of
|
|
Packit |
7cfc04 |
.IR errno
|
|
Packit |
7cfc04 |
if successful.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The behavior of these functions shall be affected by the
|
|
Packit |
7cfc04 |
.IR LC_CTYPE
|
|
Packit |
7cfc04 |
category of the current locale.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The implementation shall behave as if no function defined in System Interfaces volume of POSIX.1\(hy2008
|
|
Packit |
7cfc04 |
calls these functions.
|
|
Packit |
7cfc04 |
.SH "RETURN VALUE"
|
|
Packit |
7cfc04 |
If conversion stops because a code is reached that does not correspond
|
|
Packit |
7cfc04 |
to a valid character, an encoding error occurs. In this case, these
|
|
Packit |
7cfc04 |
functions shall store the value of the macro
|
|
Packit |
7cfc04 |
.BR [EILSEQ]
|
|
Packit |
7cfc04 |
in
|
|
Packit |
7cfc04 |
.IR errno
|
|
Packit |
7cfc04 |
and return (\fBsize_t\fP)\(mi1; the conversion state is undefined.
|
|
Packit |
7cfc04 |
Otherwise, these functions shall return the number of bytes in the
|
|
Packit |
7cfc04 |
resulting character sequence, not including the terminating null (if any).
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
These functions shall fail if:
|
|
Packit |
7cfc04 |
.TP
|
|
Packit |
7cfc04 |
.BR EILSEQ
|
|
Packit |
7cfc04 |
A wide-character code does not correspond to a valid character.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
These functions may fail if:
|
|
Packit |
7cfc04 |
.TP
|
|
Packit |
7cfc04 |
.BR EINVAL
|
|
Packit |
7cfc04 |
.IR ps
|
|
Packit |
7cfc04 |
points to an object that contains an invalid conversion state.
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH EXAMPLES
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.IR "\fImbsinit\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIwcrtomb\fR\^(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The Base Definitions volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "\fB<wchar.h>\fP"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|