WCSRTOMBS(3)

NAME
2.39 `wcsrtombs', `wcsnrtombs'--convert a wide-character string to a character string

SYNOPSIS
     #include <wchar.h>
     size_t wcsrtombs(char *DST, const wchar_t **SRC, size_t LEN,
         mbstate_t *PS);
     #include <wchar.h>
     size_t _wcsrtombs_r(struct _reent *PTR, char *DST,
         const wchar_t **SRC, size_t LEN,
         mbstate_t *PS);
     #include <wchar.h>
     size_t wcsnrtombs(char *DST, const wchar_t **SRC,
         size_t NWC, size_t LEN, mbstate_t *PS);
     #include <wchar.h>
     size_t _wcsnrtombs_r(struct _reent *PTR, char *DST,
         const wchar_t **SRC, size_t NWC,
         size_t LEN, mbstate_t *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, which is initialized to the initial conversion state at program startup.
   The `wcsnrtombs' function behaves identically to `wcsrtombs', except that conversion stops after reading at most NWC characters from the buffer pointed to by SRC.

RETURNS
The `wcsrtombs' and `wcsnrtombs' functions return 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.

PORTABILITY
`wcsrtombs' is defined by C99 standard. `wcsnrtombs' is defined by the POSIX.1-2008 standard.

SEE ALSO
wcsrtombs is part of the library. The full documentation for is maintained as a Texinfo manual. If info and are properly installed at your site, the command

    info

will give you access to the complete manual.