wcsrtombs(3C)wcsrtombs(3C)NAMEwcsrtombs() - convert a wide-character string to a character string
(restartable)
SYNOPSISDESCRIPTION
The function converts a sequence of wide-characters from the array
indirectly pointed to by src into a sequence of corresponding charac‐
ters, beginning in the conversion state described by the object pointed
to by ps. If dst is not a null pointer, the converted characters are
then stored into the array pointed to by dst. Conversion continues up
to and including a terminating null wide-character, which is also
stored. Conversion stops earlier in the following cases:
· When a code is reached that does not correspond to a valid charac‐
ter.
· When the next character would exceed the limit of len total bytes to
be stored in the array pointed to by dst (and dst is not a null
pointer).
Each conversion takes place as if by a call to the function.
If dst is not a null pointer, the pointer object pointed to by src is
assigned either a null pointer (if conversion stopped due to reaching a
terminating null wide-character) or the address just past the last
wide-character converted (if any). If conversion stopped due to reach‐
ing a terminating null wide-character, the resulting state described is
the initial conversion state.
If ps is a null pointer, the function uses its own internal object,
which is initialized at program startup to the initial conversion
state. Otherwise, the object pointed to by ps is used to completely
describe the current conversion state of the associated character
sequence. The implementation will behave as if no function defined in
this specification calls
APPLICATION USAGE
The prototype of this function is available to applications if they
are:
a. conformant.
b. Compiled with macro with a value >=500.
c. Compiled with macro with a value >= 200112.
EXTERNAL INFLUENCES
Environment Variables
The behavior of this function is affected by the category of the cur‐
rent locale.
RETURN VALUE
If conversion stops because a code is reached that does not correspond
to a valid character, an encoding error occurs. In this case, the
function stores the value of the macro in and returns (size_t)-1; the
conversion state is undefined. Otherwise, it returns the number of
bytes in the resulting character sequence, not including the terminat‐
ing null (if any).
ERRORS
The function may fail if:
A wide-character code does not correspond to a valid character.
ps points to an object that contains an invalid con‐
version state.
AUTHOR
was developed by HP and Mitsubishi Electric Corporation.
SEE ALSOmbsinit(3C), wcrtomb(3C).
wcsrtombs(3C)
