1<html lang="en"> 2<head> 3<title>mbsrtowcs - Untitled</title> 4<meta http-equiv="Content-Type" content="text/html"> 5<meta name="description" content="Untitled"> 6<meta name="generator" content="makeinfo 4.13"> 7<link title="Top" rel="start" href="index.html#Top"> 8<link rel="up" href="Stdlib.html#Stdlib" title="Stdlib"> 9<link rel="prev" href="_005f_005fmalloc_005flock.html#g_t_005f_005fmalloc_005flock" title="__malloc_lock"> 10<link rel="next" href="mbstowcs.html#mbstowcs" title="mbstowcs"> 11<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> 12<meta http-equiv="Content-Style-Type" content="text/css"> 13<style type="text/css"><!-- 14 pre.display { font-family:inherit } 15 pre.format { font-family:inherit } 16 pre.smalldisplay { font-family:inherit; font-size:smaller } 17 pre.smallformat { font-family:inherit; font-size:smaller } 18 pre.smallexample { font-size:smaller } 19 pre.smalllisp { font-size:smaller } 20 span.sc { font-variant:small-caps } 21 span.roman { font-family:serif; font-weight:normal; } 22 span.sansserif { font-family:sans-serif; font-weight:normal; } 23--></style> 24<link rel="stylesheet" type="text/css" href="../cs.css"> 25</head> 26<body> 27<div class="node"> 28<a name="mbsrtowcs"></a> 29<p> 30Next: <a rel="next" accesskey="n" href="mbstowcs.html#mbstowcs">mbstowcs</a>, 31Previous: <a rel="previous" accesskey="p" href="_005f_005fmalloc_005flock.html#g_t_005f_005fmalloc_005flock">__malloc_lock</a>, 32Up: <a rel="up" accesskey="u" href="Stdlib.html#Stdlib">Stdlib</a> 33<hr> 34</div> 35 36<h3 class="section">2.27 <code>mbsrtowcs</code>, <code>mbsnrtowcs</code>—convert a character string to a wide-character string</h3> 37 38<p><a name="index-mbsrtowcs-58"></a><a name="index-g_t_005fmbsrtowcs_005fr-59"></a><a name="index-mbsnrtowcs-60"></a><a name="index-g_t_005fmbsnrtowcs_005fr-61"></a><strong>Synopsis</strong> 39<pre class="example"> #include <wchar.h> 40 size_t mbsrtowcs(wchar_t *<var>dst</var>, const char **<var>src</var>, size_t <var>len</var>, 41 mbstate_t *<var>ps</var>); 42 43 #include <wchar.h> 44 size_t _mbsrtowcs_r(struct _reent *<var>ptr</var>, wchar_t *<var>dst</var>, 45 const char **<var>src</var>, size_t <var>len</var>, 46 mbstate_t *<var>ps</var>); 47 48 #include <wchar.h> 49 size_t mbsnrtowcs(wchar_t *<var>dst</var>, const char **<var>src</var>, 50 size_t <var>nms</var>, size_t <var>len</var>, mbstate_t *<var>ps</var>); 51 52 #include <wchar.h> 53 size_t _mbsnrtowcs_r(struct _reent *<var>ptr</var>, wchar_t *<var>dst</var>, 54 const char **<var>src</var>, size_t <var>nms</var>, 55 size_t <var>len</var>, mbstate_t *<var>ps</var>); 56 57</pre> 58 <p><strong>Description</strong><br> 59The <code>mbsrtowcs</code> function converts a sequence of multibyte characters 60pointed to indirectly by <var>src</var> into a sequence of corresponding wide 61characters and stores at most <var>len</var> of them in the wchar_t array pointed 62to by <var>dst</var>, until it encounters a terminating null character ('\0'). 63 64 <p>If <var>dst</var> is NULL, no characters are stored. 65 66 <p>If <var>dst</var> is not NULL, the pointer pointed to by <var>src</var> is updated to point 67to the character after the one that conversion stopped at. If conversion 68stops because a null character is encountered, *<var>src</var> is set to NULL. 69 70 <p>The mbstate_t argument, <var>ps</var>, is used to keep track of the shift state. If 71it is NULL, <code>mbsrtowcs</code> uses an internal, static mbstate_t object, which 72is initialized to the initial conversion state at program startup. 73 74 <p>The <code>mbsnrtowcs</code> function behaves identically to <code>mbsrtowcs</code>, except that 75conversion stops after reading at most <var>nms</var> bytes from the buffer pointed 76to by <var>src</var>. 77 78 <p><br> 79<strong>Returns</strong><br> 80The <code>mbsrtowcs</code> and <code>mbsnrtowcs</code> functions return the number of wide 81characters stored in the array pointed to by <var>dst</var> if successful, otherwise 82it returns (size_t)-1. 83 84 <p><br> 85<strong>Portability</strong><br> 86<code>mbsrtowcs</code> is defined by the C99 standard. 87<code>mbsnrtowcs</code> is defined by the POSIX.1-2008 standard. 88 89 <p><br> 90 91 </body></html> 92 93