Name

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

Library

Standard C Library (libc, -lc)

Synopsis

#include <wchar.h>

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

Description

The mbsrtowcs() function converts a sequence of multibyte characters pointed to indirectly by src into a sequence of corresponding wide characters and stores at most len of them in the wchar_t array pointed to by dst, until it encounters a terminating null character ('\0').

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, mbsrtowcs() uses an internal, static mbstate_t object.

Return Values

The mbsrtowcs() function returns the number of wide characters stored in the array pointed to by dst if successful, otherwise it returns (size_t)-1.

Errors

The mbsrtowcs() function will fail if:

[EILSEQ]

An invalid multibyte character sequence was encountered.

See Also

mbrtowc(3) , mbstowcs(3) , wcsrtombs(3)

Standards

The mbsrtowcs() 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