<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.3"/>
<title>libstdc++: std::codecvt< _InternT, _ExternT, _StateT > 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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 style="padding-left: 0.5em;">
<div id="projectname">libstdc++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</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">
$(document).ready(function(){initNavTree('a00614.html','');});
</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="#pro-attribs">Protected Attributes</a> |
<a href="a02786.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">std::codecvt< _InternT, _ExternT, _StateT > Class Template Reference<div class="ingroups"><a class="el" href="a01654.html">Locales</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for std::codecvt< _InternT, _ExternT, _StateT >:</div>
<div class="dyncontent">
<div class="center"><img src="a02787.png" border="0" usemap="#std_1_1codecvt_3_01___intern_t_00_01___extern_t_00_01___state_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="std_1_1codecvt_3_01___intern_t_00_01___extern_t_00_01___state_t_01_4_inherit__map" id="std_1_1codecvt_3_01___intern_t_00_01___extern_t_00_01___state_t_01_4_inherit__map">
<area shape="rect" id="node9" href="a00619.html" title="class codecvt_byname [22.2.1.6]." alt="" coords="61,270,197,322"/><area shape="rect" id="node2" href="a00003.html" title="Common base for codecvt functions." alt="" coords="45,81,213,133"/><area shape="rect" id="node4" href="a00801.html" title="Localization functionality base class.The facet class is the base class for a localization feature..." alt="" coords="5,6,115,31"/><area shape="rect" id="node6" href="a00618.html" title="Empty base class for codecvt facet [22.2.1.5]." alt="" coords="139,6,259,31"/></map>
<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:af65e3457da8c2e0b75c836cfee56dd97"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af65e3457da8c2e0b75c836cfee56dd97"></a>
typedef _ExternT </td><td class="memItemRight" valign="bottom"><b>extern_type</b></td></tr>
<tr class="separator:af65e3457da8c2e0b75c836cfee56dd97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f400e515e04943dc32245921f30da94"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f400e515e04943dc32245921f30da94"></a>
typedef _InternT </td><td class="memItemRight" valign="bottom"><b>intern_type</b></td></tr>
<tr class="separator:a0f400e515e04943dc32245921f30da94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61e87a0ba6a9519f99fddce94c29ca35"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61e87a0ba6a9519f99fddce94c29ca35"></a>
typedef codecvt_base::result </td><td class="memItemRight" valign="bottom"><b>result</b></td></tr>
<tr class="separator:a61e87a0ba6a9519f99fddce94c29ca35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a503e74a9097228e20e85f69f35821c8a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a503e74a9097228e20e85f69f35821c8a"></a>
typedef _StateT </td><td class="memItemRight" valign="bottom"><b>state_type</b></td></tr>
<tr class="separator:a503e74a9097228e20e85f69f35821c8a"><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:a61a40910b4c6bcd5d09ba4d3d550c64a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61a40910b4c6bcd5d09ba4d3d550c64a"></a>
 </td><td class="memItemRight" valign="bottom"><b>codecvt</b> (size_t __refs=0)</td></tr>
<tr class="separator:a61a40910b4c6bcd5d09ba4d3d550c64a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa85250f683a014bfe4156423caa52aaa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa85250f683a014bfe4156423caa52aaa"></a>
 </td><td class="memItemRight" valign="bottom"><b>codecvt</b> (__c_locale __cloc, size_t __refs=0)</td></tr>
<tr class="separator:aa85250f683a014bfe4156423caa52aaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a410904fd95fda5af2e552ba384c98dfa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a410904fd95fda5af2e552ba384c98dfa"></a>
bool </td><td class="memItemRight" valign="bottom"><b>always_noconv</b> () const throw ()</td></tr>
<tr class="separator:a410904fd95fda5af2e552ba384c98dfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b35a8d6894adcd5f29f0d37a2520fa9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b35a8d6894adcd5f29f0d37a2520fa9"></a>
int </td><td class="memItemRight" valign="bottom"><b>encoding</b> () const throw ()</td></tr>
<tr class="separator:a5b35a8d6894adcd5f29f0d37a2520fa9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18ef5d80a91835a38ed00754c64d414e"><td class="memItemLeft" align="right" valign="top">result </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a18ef5d80a91835a38ed00754c64d414e">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:a18ef5d80a91835a38ed00754c64d414e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7cbf642098347163b7a790e50e03c200"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cbf642098347163b7a790e50e03c200"></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:a7cbf642098347163b7a790e50e03c200"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a234afca5cf10abc92ec0c2b4e2f4b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a234afca5cf10abc92ec0c2b4e2f4b5"></a>
int </td><td class="memItemRight" valign="bottom"><b>max_length</b> () const throw ()</td></tr>
<tr class="separator:a0a234afca5cf10abc92ec0c2b4e2f4b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dba405c1b1ec4d38ce49ace96e844b8"><td class="memItemLeft" align="right" valign="top">result </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a5dba405c1b1ec4d38ce49ace96e844b8">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:a5dba405c1b1ec4d38ce49ace96e844b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a254f4ced9556f8f1b3170a47bc632975"><td class="memItemLeft" align="right" valign="top">result </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a254f4ced9556f8f1b3170a47bc632975">unshift</a> (state_type &__state, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const </td></tr>
<tr class="separator:a254f4ced9556f8f1b3170a47bc632975"><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:a26aa8cb2ebc1250e56c203a4f9cfb1b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26aa8cb2ebc1250e56c203a4f9cfb1b2"></a>
static <a class="el" href="a00802.html">locale::id</a> </td><td class="memItemRight" valign="bottom"><b>id</b></td></tr>
<tr class="separator:a26aa8cb2ebc1250e56c203a4f9cfb1b2"><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:a41149e2758ac2e3022492b169d2f8a3a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41149e2758ac2e3022492b169d2f8a3a"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><b>do_always_noconv</b> () const throw ()</td></tr>
<tr class="separator:a41149e2758ac2e3022492b169d2f8a3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af126f9a21253216032cdd49b9bd3d649"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af126f9a21253216032cdd49b9bd3d649"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>do_encoding</b> () const throw ()</td></tr>
<tr class="separator:af126f9a21253216032cdd49b9bd3d649"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c587e625edcda3a40853548929dd76e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c587e625edcda3a40853548929dd76e"></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:a1c587e625edcda3a40853548929dd76e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa972de8eaa435e8e2429e48e8c295f1c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa972de8eaa435e8e2429e48e8c295f1c"></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:aa972de8eaa435e8e2429e48e8c295f1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af91cba98f81e8039c9809434429a4b3a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af91cba98f81e8039c9809434429a4b3a"></a>
virtual int </td><td class="memItemRight" valign="bottom"><b>do_max_length</b> () const throw ()</td></tr>
<tr class="separator:af91cba98f81e8039c9809434429a4b3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a5c720e37027b56e41f10b8e9313821"><td class="memItemLeft" align="right" valign="top">virtual result </td><td class="memItemRight" valign="bottom"><a class="el" href="a00614.html#a7a5c720e37027b56e41f10b8e9313821">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:a7a5c720e37027b56e41f10b8e9313821"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9279960c5925f70a068441d087fc933"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9279960c5925f70a068441d087fc933"></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:aa9279960c5925f70a068441d087fc933"><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 class="anchor" 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 class="anchor" 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 class="anchor" 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 class="anchor" 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 class="anchor" 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 class="anchor" 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><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a8d3a9465a9b70c1659aee640630f6327"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d3a9465a9b70c1659aee640630f6327"></a>
__c_locale </td><td class="memItemRight" valign="bottom"><b>_M_c_locale_codecvt</b></td></tr>
<tr class="separator:a8d3a9465a9b70c1659aee640630f6327"><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<typename _InternT, typename _ExternT, typename _StateT><br/>
class std::codecvt< _InternT, _ExternT, _StateT ></h3>
<p>Primary class template codecvt.</p>
<p>NB: Generic, mostly useless implementation. </p>
<p>Definition at line <a class="el" href="a01044_source.html#l00277">277</a> of file <a class="el" href="a01044_source.html">codecvt.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7a5c720e37027b56e41f10b8e9313821"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _InternT , typename _ExternT , typename _StateT > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual result <a class="el" href="a00614.html">std::codecvt</a>< _InternT, _ExternT, _StateT >::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><a class="el" href="a00003.html#a5dba405c1b1ec4d38ce49ace96e844b8" title="Convert from internal to external character set.">out</a> for more information. </dd></dl>
<p>Implements <a class="el" href="a00003.html#aa969d1e16dd100e737c5d777aa0cdf02">std::__codecvt_abstract_base< _InternT, _ExternT, _StateT ></a>.</p>
</div>
</div>
<a class="anchor" id="a18ef5d80a91835a38ed00754c64d414e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _InternT, typename _ExternT, typename _StateT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">result <a class="el" href="a00003.html">std::__codecvt_abstract_base</a>< _InternT, _ExternT, _StateT >::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>Definition at line <a class="el" href="a01044_source.html#l00197">197</a> of file <a class="el" href="a01044_source.html">codecvt.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5dba405c1b1ec4d38ce49ace96e844b8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _InternT, typename _ExternT, typename _StateT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">result <a class="el" href="a00003.html">std::__codecvt_abstract_base</a>< _InternT, _ExternT, _StateT >::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 <a class="el" href="a00614.html#a7a5c720e37027b56e41f10b8e9313821" title="Convert from internal to external character set.">codecvt::do_out</a>.</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>Definition at line <a class="el" href="a01044_source.html#l00117">117</a> of file <a class="el" href="a01044_source.html">codecvt.h</a>.</p>
</div>
</div>
<a class="anchor" id="a254f4ced9556f8f1b3170a47bc632975"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _InternT, typename _ExternT, typename _StateT> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">result <a class="el" href="a00003.html">std::__codecvt_abstract_base</a>< _InternT, _ExternT, _StateT >::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 <a class="el" href="a00003.html#a18ef5d80a91835a38ed00754c64d414e" title="Convert from external to internal character set.">in()</a> 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>Definition at line <a class="el" href="a01044_source.html#l00156">156</a> of file <a class="el" href="a01044_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="a01044_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="a01604.html">std</a></li><li class="navelem"><a class="el" href="a00614.html">codecvt</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.3 </li>
</ul>
</div>
</body>
</html>
