<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libstdc++: std::codecvt< char16_t, char, mbstate_t > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libstdc++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a05148.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="a05145.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">std::codecvt< char16_t, char, mbstate_t > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for std::codecvt< char16_t, char, mbstate_t >:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a05147.svg" width="264" height="223"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ae4c545a78162288f04c448b8ba021cce"><td class="memItemLeft" align="right" valign="top"><a id="ae4c545a78162288f04c448b8ba021cce"></a>
typedef char </td><td class="memItemRight" valign="bottom"><b>extern_type</b></td></tr>
<tr class="separator:ae4c545a78162288f04c448b8ba021cce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ffb0795a796bd6fd2d200bbc4879c99"><td class="memItemLeft" align="right" valign="top"><a id="a7ffb0795a796bd6fd2d200bbc4879c99"></a>
typedef char16_t </td><td class="memItemRight" valign="bottom"><b>intern_type</b></td></tr>
<tr class="separator:a7ffb0795a796bd6fd2d200bbc4879c99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ebf804102d2ecf297e281485b2bb54b"><td class="memItemLeft" align="right" valign="top"><a id="a9ebf804102d2ecf297e281485b2bb54b"></a>
typedef codecvt_base::result </td><td class="memItemRight" valign="bottom"><b>result</b></td></tr>
<tr class="separator:a9ebf804102d2ecf297e281485b2bb54b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7922e05825d7ae224e832f1978ecb40e"><td class="memItemLeft" align="right" valign="top"><a id="a7922e05825d7ae224e832f1978ecb40e"></a>
typedef mbstate_t </td><td class="memItemRight" valign="bottom"><b>state_type</b></td></tr>
<tr class="separator:a7922e05825d7ae224e832f1978ecb40e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2bfac8c2e52f490c8a324a29682d3b54"><td class="memItemLeft" align="right" valign="top"><a id="a2bfac8c2e52f490c8a324a29682d3b54"></a>
 </td><td class="memItemRight" valign="bottom"><b>codecvt</b> (size_t __refs=0)</td></tr>
<tr class="separator:a2bfac8c2e52f490c8a324a29682d3b54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8496358b6c4d241007c857d05a25bcd"><td class="memItemLeft" align="right" valign="top"><a id="af8496358b6c4d241007c857d05a25bcd"></a>
bool </td><td class="memItemRight" valign="bottom"><b>always_noconv</b> () const throw ()</td></tr>
<tr class="separator:af8496358b6c4d241007c857d05a25bcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a66a5e8e725c4cfe6ebc0926bf4aebc"><td class="memItemLeft" align="right" valign="top"><a id="a2a66a5e8e725c4cfe6ebc0926bf4aebc"></a>
int </td><td class="memItemRight" valign="bottom"><b>encoding</b> () const throw ()</td></tr>
<tr class="separator:a2a66a5e8e725c4cfe6ebc0926bf4aebc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38117d39e9725f52735f51f4f4b72354"><td class="memItemLeft" align="right" valign="top">result </td><td class="memItemRight" valign="bottom"><a class="el" href="a05132.html#a38117d39e9725f52735f51f4f4b72354">in</a> (state_type &__state, const extern_type *__from, const extern_type *__from_end, const extern_type *&__from_next, intern_type *__to, intern_type *__to_end, intern_type *&__to_next) const</td></tr>
<tr class="separator:a38117d39e9725f52735f51f4f4b72354"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7feb5f52e3e4153e17f924bc5f208f9d"><td class="memItemLeft" align="right" valign="top"><a id="a7feb5f52e3e4153e17f924bc5f208f9d"></a>
int </td><td class="memItemRight" valign="bottom"><b>length</b> (state_type &__state, const extern_type *__from, const extern_type *__end, size_t __max) const</td></tr>
<tr class="separator:a7feb5f52e3e4153e17f924bc5f208f9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a743b3476e30eae2dbb5c8dfebe3d4ce8"><td class="memItemLeft" align="right" valign="top"><a id="a743b3476e30eae2dbb5c8dfebe3d4ce8"></a>
int </td><td class="memItemRight" valign="bottom"><b>max_length</b> () const throw ()</td></tr>
<tr class="separator:a743b3476e30eae2dbb5c8dfebe3d4ce8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a2b1f2da1bc0d89ccd1eceaa66bb79f"><td class="memItemLeft" align="right" valign="top">result </td><td class="memItemRight" valign="bottom"><a class="el" href="a05132.html#a3a2b1f2da1bc0d89ccd1eceaa66bb79f">out</a> (state_type &__state, const intern_type *__from, const intern_type *__from_end, const intern_type *&__from_next, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const</td></tr>
<tr class="separator:a3a2b1f2da1bc0d89ccd1eceaa66bb79f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4da56b36b489eded5053172e9f6c0bff"><td class="memItemLeft" align="right" valign="top">result </td><td class="memItemRight" valign="bottom"><a class="el" href="a05132.html#a4da56b36b489eded5053172e9f6c0bff">unshift</a> (state_type &__state, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const</td></tr>
<tr class="separator:a4da56b36b489eded5053172e9f6c0bff"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a1ec6cb4ec0a076fefe9cd225d9627e22"><td class="memItemLeft" align="right" valign="top"><a id="a1ec6cb4ec0a076fefe9cd225d9627e22"></a>
static <a class="el" href="a05824.html">locale::id</a> </td><td class="memItemRight" valign="bottom"><b>id</b></td></tr>
<tr class="separator:a1ec6cb4ec0a076fefe9cd225d9627e22"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a4c12757e314e11f7e59a856497d68b8c"><td class="memItemLeft" align="right" valign="top"><a id="a4c12757e314e11f7e59a856497d68b8c"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><b>do_always_noconv</b> () const throw ()</td></tr>
<tr class="separator:a4c12757e314e11f7e59a856497d68b8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76514f5ecb899ea10595fb642f060d42"><td class="memItemLeft" align="right" valign="top"><a id="a76514f5ecb899ea10595fb642f060d42"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>do_encoding</b> () const throw ()</td></tr>
<tr class="separator:a76514f5ecb899ea10595fb642f060d42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54ad01f172c22c583d825fe560b2b66b"><td class="memItemLeft" align="right" valign="top"><a id="a54ad01f172c22c583d825fe560b2b66b"></a>
virtual result </td><td class="memItemRight" valign="bottom"><b>do_in</b> (state_type &__state, const extern_type *__from, const extern_type *__from_end, const extern_type *&__from_next, intern_type *__to, intern_type *__to_end, intern_type *&__to_next) const</td></tr>
<tr class="separator:a54ad01f172c22c583d825fe560b2b66b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc00c68f51b9ff705aca46f1f06306ac"><td class="memItemLeft" align="right" valign="top"><a id="afc00c68f51b9ff705aca46f1f06306ac"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>do_length</b> (state_type &, const extern_type *__from, const extern_type *__end, size_t __max) const</td></tr>
<tr class="separator:afc00c68f51b9ff705aca46f1f06306ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb678c45a7b090019205fe0420a5be1e"><td class="memItemLeft" align="right" valign="top"><a id="aeb678c45a7b090019205fe0420a5be1e"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>do_max_length</b> () const throw ()</td></tr>
<tr class="separator:aeb678c45a7b090019205fe0420a5be1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16f65a78cd4179ab7115490453e3664e"><td class="memItemLeft" align="right" valign="top">virtual result </td><td class="memItemRight" valign="bottom"><a class="el" href="a05148.html#a16f65a78cd4179ab7115490453e3664e">do_out</a> (state_type &__state, const intern_type *__from, const intern_type *__from_end, const intern_type *&__from_next, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const</td></tr>
<tr class="separator:a16f65a78cd4179ab7115490453e3664e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a635c9e49798126e4b5e5976b8f630084"><td class="memItemLeft" align="right" valign="top"><a id="a635c9e49798126e4b5e5976b8f630084"></a>
virtual result </td><td class="memItemRight" valign="bottom"><b>do_unshift</b> (state_type &__state, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const</td></tr>
<tr class="separator:a635c9e49798126e4b5e5976b8f630084"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:aaaa39cc3ae39c5283101ce8c9c630902"><td class="memItemLeft" align="right" valign="top"><a id="aaaa39cc3ae39c5283101ce8c9c630902"></a>
static __c_locale </td><td class="memItemRight" valign="bottom"><b>_S_clone_c_locale</b> (__c_locale &__cloc) throw ()</td></tr>
<tr class="separator:aaaa39cc3ae39c5283101ce8c9c630902"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60fbe742b113ff90f63e01c0ac658826"><td class="memItemLeft" align="right" valign="top"><a id="a60fbe742b113ff90f63e01c0ac658826"></a>
static void </td><td class="memItemRight" valign="bottom"><b>_S_create_c_locale</b> (__c_locale &__cloc, const char *__s, __c_locale __old=0)</td></tr>
<tr class="separator:a60fbe742b113ff90f63e01c0ac658826"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a8c1c763d0d99421ab859f9c11668af"><td class="memItemLeft" align="right" valign="top"><a id="a0a8c1c763d0d99421ab859f9c11668af"></a>
static void </td><td class="memItemRight" valign="bottom"><b>_S_destroy_c_locale</b> (__c_locale &__cloc)</td></tr>
<tr class="separator:a0a8c1c763d0d99421ab859f9c11668af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e71ffc16033618e86c8c9d14ae4b022"><td class="memItemLeft" align="right" valign="top"><a id="a2e71ffc16033618e86c8c9d14ae4b022"></a>
static __c_locale </td><td class="memItemRight" valign="bottom"><b>_S_get_c_locale</b> ()</td></tr>
<tr class="separator:a2e71ffc16033618e86c8c9d14ae4b022"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acda690006956a82c0cc436f5509c4f26"><td class="memItemLeft" align="right" valign="top"><a id="acda690006956a82c0cc436f5509c4f26"></a>
static const char * </td><td class="memItemRight" valign="bottom"><b>_S_get_c_name</b> () throw ()</td></tr>
<tr class="separator:acda690006956a82c0cc436f5509c4f26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a426725452f3ac010eb3c090e83a6e574"><td class="memItemLeft" align="right" valign="top"><a id="a426725452f3ac010eb3c090e83a6e574"></a>
static __c_locale </td><td class="memItemRight" valign="bottom"><b>_S_lc_ctype_c_locale</b> (__c_locale __cloc, const char *__s)</td></tr>
<tr class="separator:a426725452f3ac010eb3c090e83a6e574"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<><br />
class std::codecvt< char16_t, char, mbstate_t ></h3>
<p>Class codecvt<char16_t, char, mbstate_t> specialization. </p>
<p>Converts between UTF-16 and UTF-8. </p>
<p class="definition">Definition at line <a class="el" href="a00305_source.html#l00468">468</a> of file <a class="el" href="a00305_source.html">codecvt.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a16f65a78cd4179ab7115490453e3664e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16f65a78cd4179ab7115490453e3664e">◆ </a></span>do_out()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual result <a class="el" href="a05136.html">std::codecvt</a>< char16_t, char, mbstate_t >::do_out </td>
<td>(</td>
<td class="paramtype">state_type & </td>
<td class="paramname"><em>__state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const intern_type * </td>
<td class="paramname"><em>__from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const intern_type * </td>
<td class="paramname"><em>__from_end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const intern_type *& </td>
<td class="paramname"><em>__from_next</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">extern_type * </td>
<td class="paramname"><em>__to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">extern_type * </td>
<td class="paramname"><em>__to_end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">extern_type *& </td>
<td class="paramname"><em>__to_next</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert from internal to external character set. </p>
<p>Converts input string of intern_type to output string of extern_type. This function is a hook for derived classes to change the value returned. </p><dl class="section see"><dt>See also</dt><dd>out for more information. </dd></dl>
<p>Implements <a class="el" href="a05132.html#aa969d1e16dd100e737c5d777aa0cdf02">std::__codecvt_abstract_base< char16_t, char, mbstate_t ></a>.</p>
</div>
</div>
<a id="a38117d39e9725f52735f51f4f4b72354"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38117d39e9725f52735f51f4f4b72354">◆ </a></span>in()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">result <a class="el" href="a05132.html">std::__codecvt_abstract_base</a>< char16_t , char , mbstate_t >::in </td>
<td>(</td>
<td class="paramtype">state_type & </td>
<td class="paramname"><em>__state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const extern_type * </td>
<td class="paramname"><em>__from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const extern_type * </td>
<td class="paramname"><em>__from_end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const extern_type *& </td>
<td class="paramname"><em>__from_next</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">intern_type * </td>
<td class="paramname"><em>__to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">intern_type * </td>
<td class="paramname"><em>__to_end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">intern_type *& </td>
<td class="paramname"><em>__to_next</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert from external to internal character set. </p>
<p>Converts input string of extern_type to output string of intern_type. This is analogous to mbsrtowcs. It does this by calling codecvt::do_in.</p>
<p>The source and destination character sets are determined by the facet's locale, internal and external types.</p>
<p>The characters in [from,from_end) are converted and written to [to,to_end). from_next and to_next are set to point to the character following the last successfully converted character, respectively. If the result needed no conversion, from_next and to_next are not affected.</p>
<p>The <em>state</em> argument should be initialized if the input is at the beginning and carried from a previous call if continuing conversion. There are no guarantees about how <em>state</em> is used.</p>
<p>The result returned is a member of codecvt_base::result. If all the input is converted, returns codecvt_base::ok. If no conversion is necessary, returns codecvt_base::noconv. If the input ends early or there is insufficient space in the output, returns codecvt_base::partial. Otherwise the conversion failed and codecvt_base::error is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">__state</td><td>Persistent conversion state data. </td></tr>
<tr><td class="paramname">__from</td><td>Start of input. </td></tr>
<tr><td class="paramname">__from_end</td><td>End of input. </td></tr>
<tr><td class="paramname">__from_next</td><td>Returns start of unconverted data. </td></tr>
<tr><td class="paramname">__to</td><td>Start of output buffer. </td></tr>
<tr><td class="paramname">__to_end</td><td>End of output buffer. </td></tr>
<tr><td class="paramname">__to_next</td><td>Returns start of unused output area. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>codecvt_base::result. </dd></dl>
<p class="definition">Definition at line <a class="el" href="a00305_source.html#l00196">196</a> of file <a class="el" href="a00305_source.html">codecvt.h</a>.</p>
</div>
</div>
<a id="a3a2b1f2da1bc0d89ccd1eceaa66bb79f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a2b1f2da1bc0d89ccd1eceaa66bb79f">◆ </a></span>out()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">result <a class="el" href="a05132.html">std::__codecvt_abstract_base</a>< char16_t , char , mbstate_t >::out </td>
<td>(</td>
<td class="paramtype">state_type & </td>
<td class="paramname"><em>__state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const intern_type * </td>
<td class="paramname"><em>__from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const intern_type * </td>
<td class="paramname"><em>__from_end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const intern_type *& </td>
<td class="paramname"><em>__from_next</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">extern_type * </td>
<td class="paramname"><em>__to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">extern_type * </td>
<td class="paramname"><em>__to_end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">extern_type *& </td>
<td class="paramname"><em>__to_next</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert from internal to external character set. </p>
<p>Converts input string of intern_type to output string of extern_type. This is analogous to wcsrtombs. It does this by calling codecvt::do_out.</p>
<p>The source and destination character sets are determined by the facet's locale, internal and external types.</p>
<p>The characters in [from,from_end) are converted and written to [to,to_end). from_next and to_next are set to point to the character following the last successfully converted character, respectively. If the result needed no conversion, from_next and to_next are not affected.</p>
<p>The <em>state</em> argument should be initialized if the input is at the beginning and carried from a previous call if continuing conversion. There are no guarantees about how <em>state</em> is used.</p>
<p>The result returned is a member of codecvt_base::result. If all the input is converted, returns codecvt_base::ok. If no conversion is necessary, returns codecvt_base::noconv. If the input ends early or there is insufficient space in the output, returns codecvt_base::partial. Otherwise the conversion failed and codecvt_base::error is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">__state</td><td>Persistent conversion state data. </td></tr>
<tr><td class="paramname">__from</td><td>Start of input. </td></tr>
<tr><td class="paramname">__from_end</td><td>End of input. </td></tr>
<tr><td class="paramname">__from_next</td><td>Returns start of unconverted data. </td></tr>
<tr><td class="paramname">__to</td><td>Start of output buffer. </td></tr>
<tr><td class="paramname">__to_end</td><td>End of output buffer. </td></tr>
<tr><td class="paramname">__to_next</td><td>Returns start of unused output area. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>codecvt_base::result. </dd></dl>
<p class="definition">Definition at line <a class="el" href="a00305_source.html#l00116">116</a> of file <a class="el" href="a00305_source.html">codecvt.h</a>.</p>
</div>
</div>
<a id="a4da56b36b489eded5053172e9f6c0bff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4da56b36b489eded5053172e9f6c0bff">◆ </a></span>unshift()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">result <a class="el" href="a05132.html">std::__codecvt_abstract_base</a>< char16_t , char , mbstate_t >::unshift </td>
<td>(</td>
<td class="paramtype">state_type & </td>
<td class="paramname"><em>__state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">extern_type * </td>
<td class="paramname"><em>__to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">extern_type * </td>
<td class="paramname"><em>__to_end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">extern_type *& </td>
<td class="paramname"><em>__to_next</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset conversion state. </p>
<p>Writes characters to output that would restore <em>state</em> to initial conditions. The idea is that if a partial conversion occurs, then the converting the characters written by this function would leave the state in initial conditions, rather than partial conversion state. It does this by calling codecvt::do_unshift().</p>
<p>For example, if 4 external characters always converted to 1 internal character, and input to in() had 6 external characters with state saved, this function would write two characters to the output and set the state to initialized conditions.</p>
<p>The source and destination character sets are determined by the facet's locale, internal and external types.</p>
<p>The result returned is a member of codecvt_base::result. If the state could be reset and data written, returns codecvt_base::ok. If no conversion is necessary, returns codecvt_base::noconv. If the output has insufficient space, returns codecvt_base::partial. Otherwise the reset failed and codecvt_base::error is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">__state</td><td>Persistent conversion state data. </td></tr>
<tr><td class="paramname">__to</td><td>Start of output buffer. </td></tr>
<tr><td class="paramname">__to_end</td><td>End of output buffer. </td></tr>
<tr><td class="paramname">__to_next</td><td>Returns start of unused output area. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>codecvt_base::result. </dd></dl>
<p class="definition">Definition at line <a class="el" href="a00305_source.html#l00155">155</a> of file <a class="el" href="a00305_source.html">codecvt.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00305_source.html">codecvt.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a01538.html">std</a></li><li class="navelem"><a class="el" href="a05148.html">codecvt< char16_t, char, mbstate_t ></a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
0448c66ab6afa2f787658c5e6488e2d9
>
files
>
2839
