1<html lang="en"> 2<head> 3<title>mbstowcs - 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="mbsrtowcs.html#mbsrtowcs" title="mbsrtowcs"> 10<link rel="next" href="mblen.html#mblen" title="mblen"> 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="mbstowcs"></a> 29<p> 30Next: <a rel="next" accesskey="n" href="mblen.html#mblen">mblen</a>, 31Previous: <a rel="previous" accesskey="p" href="mbsrtowcs.html#mbsrtowcs">mbsrtowcs</a>, 32Up: <a rel="up" accesskey="u" href="Stdlib.html#Stdlib">Stdlib</a> 33<hr> 34</div> 35 36<h3 class="section">2.28 <code>mbstowcs</code>—minimal multibyte string to wide char converter</h3> 37 38<p><a name="index-mbstowcs-62"></a><strong>Synopsis</strong> 39<pre class="example"> #include <stdlib.h> 40 int mbstowcs(wchar_t *<var>pwc</var>, const char *<var>s</var>, size_t <var>n</var>); 41 42</pre> 43 <p><strong>Description</strong><br> 44When _MB_CAPABLE is not defined, this is a minimal ANSI-conforming 45implementation of <code>mbstowcs</code>. In this case, the 46only “multi-byte character sequences” recognized are single bytes, 47and they are “converted” to wide-char versions simply by byte 48extension. 49 50 <p>When _MB_CAPABLE is defined, this routine calls <code>_mbstowcs_r</code> to perform 51the conversion, passing a state variable to allow state dependent 52decoding. The result is based on the locale setting which may 53be restricted to a defined set of locales. 54 55 <p><br> 56<strong>Returns</strong><br> 57This implementation of <code>mbstowcs</code> returns <code>0</code> if 58<var>s</var> is <code>NULL</code> or is the empty string; 59it returns <code>-1</code> if _MB_CAPABLE and one of the 60multi-byte characters is invalid or incomplete; 61otherwise it returns the minimum of: <code>n</code> or the 62number of multi-byte characters in <code>s</code> plus 1 (to 63compensate for the nul character). 64If the return value is -1, the state of the <code>pwc</code> string is 65indeterminate. If the input has a length of 0, the output 66string will be modified to contain a wchar_t nul terminator. 67 68 <p><br> 69<strong>Portability</strong><br> 70<code>mbstowcs</code> is required in the ANSI C standard. However, the precise 71effects vary with the locale. 72 73 <p><code>mbstowcs</code> requires no supporting OS subroutines. 74 75 <p><br> 76 77 </body></html> 78 79