Name

wcsrtombs - convert a wide-character string to a character string (restartable)

Library

Standard C Library (libc, -lc)

Synopsis

#include <wchar.h>

size_t
wcsrtombs(char * restrict dst, const wchar_t ** restrict src, size_t len, mbstate_t * restrict ps);

Description

The wcsrtombs() function converts a string of wide characters indirectly pointed to by src to a corresponding multibyte character string stored in the array pointed to by dst. No more than len bytes are written to dst.

If dst is NULL, no characters are stored.

If dst is not NULL, the pointer pointed to by src is updated to point to the character after the one that conversion stopped at. If conversion stops because a null character is encountered, *src is set to NULL.

The mbstate_t argument, ps, is used to keep track of the shift state. If it is NULL, wcsrtombs() uses an internal, static mbstate_t object.

Return Values

The wcsrtombs() function returns the number of bytes stored in the array pointed to by dst (not including any terminating null), if successful, otherwise it returns (size_t)-1.

Errors

The wcsrtombs() function will fail if:

[EILSEQ]

An invalid wide character was encountered.

See Also

mbsrtowcs(3) , wcrtomb(3) , wcstombs(3)

Standards

The wcsrtombs() function conforms to ISO/IEC 9899:1999 (``ISO C99'').

Bugs

The current implementation does not support shift states.

Table of Contents

• Name
• Library
• Synopsis
• Description
• Return Values
• Errors
• See Also
• Standards
• Bugs