WCSTOMBS(3) NEWLIB WCSTOMBS(3)NAME
2.46 `wcstombs'--minimal wide char string to multibyte string converter
SYNOPSIS
#include <stdlib.h>
size_t wcstombs(char *S, const wchar_t *PWC, size_t N);
DESCRIPTION
When _MB_CAPABLE is not defined, this is a minimal ANSI-conforming
implementation of `wcstombs'. In this case, all wide-characters are
expected to represent single bytes and so are converted simply by cast‐
ing to char.
When _MB_CAPABLE is defined, this routine calls `_wcstombs_r' to
perform the conversion, passing a state variable to allow state depen‐
dent decoding. The result is based on the locale setting which may be
restricted to a defined set of locales.
RETURNS
This implementation of `wcstombs' returns `0' if S is `NULL' or is the
empty string; it returns `-1' if _MB_CAPABLE and one of the wide-char
characters does not represent a valid multi-byte character; otherwise
it returns the minimum of: `n' or the number of bytes that are trans‐
ferred to `s', not including the nul terminator.
If the return value is -1, the state of the `pwc' string is indeter‐
minate. If the input has a length of 0, the output string will be mod‐
ified to contain a wchar_t nul terminator if `n' > 0.
PORTABILITY
`wcstombs' is required in the ANSI C standard. However, the precise
effects vary with the locale.
`wcstombs' requires no supporting OS subroutines.
SEE ALSOwcstombs is part of the library. The full documentation for is main‐
tained as a Texinfo manual. If info and are properly installed at your
site, the command
info
will give you access to the complete manual.
NEWLIB April 2010 WCSTOMBS(3)
