wcsrtombs() convert wide character string to multibyte string (restartable)	Function
	SYNOPSIS DESCRIPTION PARAMETERS RETURN VALUES CONFORMANCE MULTITHREAD SAFETY LEVEL PORTING ISSUES AVAILABILITY SEE ALSO

---

SYNOPSIS

#include <wchar.h>

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

---

DESCRIPTION

The wcsrtombs() function converts a sequence of wide characters, beginning in the specified conversion state, from the array indirectly pointed to by src into a sequence of corresponding characters. If dst is not a null pointer, the converted characters are 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 early in either of the following cases:

• When a code is encountered that does not correspond to a valid character.
• When the next character would exceed the limit of len total bytes stored into the array pointed to by dst (and dst is not a null pointer).

Each conversion takes place as if by a call to the wcrtomb() 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 reaching a terminating null wide character, the resulting state described is the initial conversion state.

If the specified state pointer is null, the wcsrtombs() function uses its own internal mbstate_t object, which is initialized at program startup to the initial conversion state. Otherwise, the specified mbstate_t object is used to completely describe the current conversion state of the associated character sequence.

The behavior of this function is affected by the LC_CTYPE category of the current locale.

---

PARAMETERS

dst 

Is the destination buffer used to receive converted characters. This can be a null pointer if no conversion is desired.

src 

Points to the string to be converted. If dst is not null, the referenced pointer is updated as described in the DESCRIPTION section.

len 

Is the maximum number of bytes characters to write to dst, if dst is not null.

ps 

Is the conversion state. If this is null, an internal mbstate_t object is used.

---

RETURN VALUES

If the input conversion encounters a code that does not correspond to a valid character, an encoding error occurs. In this case, the wcsrtombs() function sets errno to EILSEQ and returns -1; the conversion state is undefined. Otherwise, it returns the number of bytes successfully converted, not including the terminating null (if any).

---

CONFORMANCE

ANSI/ISO 9899-1990/AM 1-1995

---

MULTITHREAD SAFETY LEVEL

MT-Safe, with exceptions.

This function is MT-Safe as long as no thread calls setlocale() while this function is executing and the 'ps' parameter is non-NULL.

---

PORTING ISSUES

None.

---

AVAILABILITY

MKS Toolkit for Professional Developers
MKS Toolkit for Enterprise Developers
MKS Toolkit for Enterprise Developers 64-Bit Edition

---

SEE ALSO

Functions:

mbrlen(), mbrtowc(), mbsinit(), mbsrtowcs(), setlocale(), wcrtomb()

---

MKS Toolkit 9.3 Documentation Build 6.