<!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.5"/> <title>libstdc++: std::codecvt< _InternT, _ExternT, encoding_state > 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.5 --> </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('a00675.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="a02876.html">List of all members</a> </div> <div class="headertitle"> <div class="title">std::codecvt< _InternT, _ExternT, encoding_state > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Inheritance diagram for std::codecvt< _InternT, _ExternT, encoding_state >:</div> <div class="dyncontent"> <div class="center"><iframe scrolling="no" frameborder="0" src="a02877.svg" width="264" height="227"><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:aabc23267096416ea385ea7fd6be7b3c7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabc23267096416ea385ea7fd6be7b3c7"></a> typedef state_type::descriptor_type </td><td class="memItemRight" valign="bottom"><b>descriptor_type</b></td></tr> <tr class="separator:aabc23267096416ea385ea7fd6be7b3c7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab18dd9522b4b4b4b2e48f24ade676b62"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab18dd9522b4b4b4b2e48f24ade676b62"></a> typedef _ExternT </td><td class="memItemRight" valign="bottom"><b>extern_type</b></td></tr> <tr class="separator:ab18dd9522b4b4b4b2e48f24ade676b62"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afebacd25486d9e95474f7a5a653b5ed0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afebacd25486d9e95474f7a5a653b5ed0"></a> typedef _InternT </td><td class="memItemRight" valign="bottom"><b>intern_type</b></td></tr> <tr class="separator:afebacd25486d9e95474f7a5a653b5ed0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3b1b444e20b043f0364592be1b61d7b6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b1b444e20b043f0364592be1b61d7b6"></a> typedef codecvt_base::result </td><td class="memItemRight" valign="bottom"><b>result</b></td></tr> <tr class="separator:a3b1b444e20b043f0364592be1b61d7b6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ada11631437dc328094f18c85ebeb87bd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada11631437dc328094f18c85ebeb87bd"></a> typedef <a class="el" href="a00045.html">__gnu_cxx::encoding_state</a> </td><td class="memItemRight" valign="bottom"><b>state_type</b></td></tr> <tr class="separator:ada11631437dc328094f18c85ebeb87bd"><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:a53b0f6712a2018dfc9cd5826c1f52ecf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53b0f6712a2018dfc9cd5826c1f52ecf"></a>  </td><td class="memItemRight" valign="bottom"><b>codecvt</b> (size_t __refs=0)</td></tr> <tr class="separator:a53b0f6712a2018dfc9cd5826c1f52ecf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1e36576cd3ffb0df42e3df5b3c5390df"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e36576cd3ffb0df42e3df5b3c5390df"></a>  </td><td class="memItemRight" valign="bottom"><b>codecvt</b> (<a class="el" href="a00045.html">state_type</a> &__enc, size_t __refs=0)</td></tr> <tr class="separator:a1e36576cd3ffb0df42e3df5b3c5390df"><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> (<a class="el" href="a00045.html">state_type</a> &__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> (<a class="el" href="a00045.html">state_type</a> &__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> (<a class="el" href="a00045.html">state_type</a> &__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> (<a class="el" href="a00045.html">state_type</a> &__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:ad0bf0359e417bfd2b2ace143a5460492"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0bf0359e417bfd2b2ace143a5460492"></a> static <a class="el" href="a00863.html">locale::id</a> </td><td class="memItemRight" valign="bottom"><b>id</b></td></tr> <tr class="separator:ad0bf0359e417bfd2b2ace143a5460492"><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:a85ca55d09d9db9570c8d999293ba3b80"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85ca55d09d9db9570c8d999293ba3b80"></a> virtual bool </td><td class="memItemRight" valign="bottom"><b>do_always_noconv</b> () const throw ()</td></tr> <tr class="separator:a85ca55d09d9db9570c8d999293ba3b80"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a22660dc429ef653d4254d5726de74525"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22660dc429ef653d4254d5726de74525"></a> virtual int </td><td class="memItemRight" valign="bottom"><b>do_encoding</b> () const throw ()</td></tr> <tr class="separator:a22660dc429ef653d4254d5726de74525"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5defeb721bd2ece22b841d2518b1fbc7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5defeb721bd2ece22b841d2518b1fbc7"></a> virtual result </td><td class="memItemRight" valign="bottom"><b>do_in</b> (<a class="el" href="a00045.html">state_type</a> &__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:a5defeb721bd2ece22b841d2518b1fbc7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acaefe4a229577ec61187aaaf3b8176d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acaefe4a229577ec61187aaaf3b8176d6"></a> virtual int </td><td class="memItemRight" valign="bottom"><b>do_length</b> (<a class="el" href="a00045.html">state_type</a> &, const extern_type *__from, const extern_type *__end, size_t __max) const </td></tr> <tr class="separator:acaefe4a229577ec61187aaaf3b8176d6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a31f96a8448567977c819c9c332f5d394"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31f96a8448567977c819c9c332f5d394"></a> virtual int </td><td class="memItemRight" valign="bottom"><b>do_max_length</b> () const throw ()</td></tr> <tr class="separator:a31f96a8448567977c819c9c332f5d394"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adf9d866083c98b86e7665ac6ddd06c5b"><td class="memItemLeft" align="right" valign="top">virtual result </td><td class="memItemRight" valign="bottom"><a class="el" href="a00675.html#adf9d866083c98b86e7665ac6ddd06c5b">do_out</a> (<a class="el" href="a00045.html">state_type</a> &__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:adf9d866083c98b86e7665ac6ddd06c5b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae505377ac4999b6303f6f31b0ac2523c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae505377ac4999b6303f6f31b0ac2523c"></a> virtual result </td><td class="memItemRight" valign="bottom"><b>do_unshift</b> (<a class="el" href="a00045.html">state_type</a> &__state, extern_type *__to, extern_type *__to_end, extern_type *&__to_next) const </td></tr> <tr class="separator:ae505377ac4999b6303f6f31b0ac2523c"><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> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<typename _InternT, typename _ExternT><br/> class std::codecvt< _InternT, _ExternT, encoding_state ></h3> <p>codecvt<InternT, _ExternT, encoding_state> specialization. </p> <p>Definition at line <a class="el" href="a01100_source.html#l00230">230</a> of file <a class="el" href="a01100_source.html">codecvt_specializations.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="adf9d866083c98b86e7665ac6ddd06c5b"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _InternT , typename _ExternT > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">codecvt_base::result <a class="el" href="a00674.html">std::codecvt</a>< _InternT, _ExternT, <a class="el" href="a00045.html">encoding_state</a> >::do_out </td> <td>(</td> <td class="paramtype"><a class="el" href="a00045.html">state_type</a> & </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="a00003.html#aa969d1e16dd100e737c5d777aa0cdf02">std::__codecvt_abstract_base< _InternT, _ExternT, encoding_state ></a>.</p> <p>Definition at line <a class="el" href="a01100_source.html#l00306">306</a> of file <a class="el" href="a01100_source.html">codecvt_specializations.h</a>.</p> </div> </div> <a class="anchor" id="a18ef5d80a91835a38ed00754c64d414e"></a> <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="a00003.html">std::__codecvt_abstract_base</a>< _InternT, _ExternT, <a class="el" href="a00045.html">encoding_state</a> >::in </td> <td>(</td> <td class="paramtype"><a class="el" href="a00045.html">state_type</a> & </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="a01099_source.html#l00196">196</a> of file <a class="el" href="a01099_source.html">codecvt.h</a>.</p> </div> </div> <a class="anchor" id="a5dba405c1b1ec4d38ce49ace96e844b8"></a> <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="a00003.html">std::__codecvt_abstract_base</a>< _InternT, _ExternT, <a class="el" href="a00045.html">encoding_state</a> >::out </td> <td>(</td> <td class="paramtype"><a class="el" href="a00045.html">state_type</a> & </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>Definition at line <a class="el" href="a01099_source.html#l00116">116</a> of file <a class="el" href="a01099_source.html">codecvt.h</a>.</p> <p>References <a class="el" href="a00003.html#aa969d1e16dd100e737c5d777aa0cdf02">std::__codecvt_abstract_base< _InternT, _ExternT, _StateT >::do_out()</a>.</p> </div> </div> <a class="anchor" id="a254f4ced9556f8f1b3170a47bc632975"></a> <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="a00003.html">std::__codecvt_abstract_base</a>< _InternT, _ExternT, <a class="el" href="a00045.html">encoding_state</a> >::unshift </td> <td>(</td> <td class="paramtype"><a class="el" href="a00045.html">state_type</a> & </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>Definition at line <a class="el" href="a01099_source.html#l00155">155</a> of file <a class="el" href="a01099_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="a01100_source.html">codecvt_specializations.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="a01662.html">std</a></li><li class="navelem"><a class="el" href="a00675.html">codecvt< _InternT, _ExternT, encoding_state ></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.5 </li> </ul> </div> </body> </html>