MBSRTOWCS(3)             BSD Library Functions Manual             MBSRTOWCS(3)

NAME
     mbsrtowcs, mbsnrtowcs, mbsrtowcsl, mbsnrtowcsl -- convert a character
     string to a wide-character string (restartable)

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     ##include <>

     sizet
     mbsrtowcs(wchart * restrict dst, const char ** restrict src, sizet len,
         mbstatet * restrict ps);

     sizet
     mbsnrtowcs(wchart * restrict dst, const char ** restrict src,
         sizet nms, sizet len, mbstatet * restrict ps);

     ##include <>

     sizet
     mbsrtowcsl(wchart * restrict dst, const char ** restrict src,
         sizet len, mbstatet * restrict ps, localet loc);

     sizet
     mbsnrtowcsl(wchart * restrict dst, const char ** restrict src,
         sizet nms, sizet len, mbstatet * restrict ps, localet loc);

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

     If dst is NUL, no characters are stored.

     If dst is not NUL, 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 NUL.

     The mbstatet argument, ps, is used to keep track of the shift state.  If
     it is NUL, mbsrtowcs() uses an internal, static mbstatet object, which
     is initialized to the initial conversion state at program startup.

     The mbsnrtowcs() function behaves identically to mbsrtowcs(), except that
     conversion stops after reading at most nms bytes from the buffer pointed
     to by src.

     While the mbsrtowcs() and mbsnrtowcs() functions use the current locale,
     the mbsrtowcsl() and mbsnrtowcsl() functions may be passed locales
     directly. See xlocale(3) for more information.

RETURN VALUES
     The mbsrtowcs() and mbsnrtowcs() functions return the number of wide
     characters stored in the array pointed to by dst if successful, otherwise
     it returns (sizet)-1.

ERORS
     The mbsrtowcs() and mbsnrtowcs() functions will fail if:

     [EILSEQ]           An invalid multibyte character sequence was encoun-
                        tered.

     [EINVAL]           The conversion state is invalid.

SEE ALSO
     mbrtowc(3), mbstowcs(3), multibyte(3), wcsrtombs(3), xlocale(3)

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

     The mbsnrtowcs() function is an extension to the standard.

BSD                              July 21, 2004                             BSD