NAME    [Toc]    [Back]

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

LIBRARY    [Toc]    [Back]

     Standard C Library (libc, -lc)

SYNOPSIS    [Toc]    [Back]

     #include <wchar.h>

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

DESCRIPTION    [Toc]    [Back]

     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    [Toc]    [Back]

     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    [Toc]    [Back]

     The wcsrtombs() function will fail if:

     [EILSEQ]		An invalid wide character was encountered.

SEE ALSO    [Toc]    [Back]

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

STANDARDS    [Toc]    [Back]

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

BUGS    [Toc]    [Back]

     The current implementation does not support shift states.


FreeBSD 5.2.1			August 16, 2002 		 FreeBSD 5.2.1