<!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.11"/> <title>glibmm: Glib::IConv Class 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="doxygen.css" rel="stylesheet" type="text/css" /> <link href="doxygen-extra.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">glibmm  <span id="projectnumber">2.60.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceGlib.html">Glib</a></li><li class="navelem"><a class="el" href="classGlib_1_1IConv.html">IConv</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classGlib_1_1IConv-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Glib::IConv Class Reference<div class="ingroups"><a class="el" href="group__CharsetConv.html">Character Set Conversion</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Thin iconv() wrapper. <a href="classGlib_1_1IConv.html#details">More...</a></p> <p><code>#include <glibmm/convert.h></code></p> <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:abb841f9db0731eb8cbc4ea2a8a5d23d5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1IConv.html#abb841f9db0731eb8cbc4ea2a8a5d23d5">IConv</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01512.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a>& to_codeset, const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01512.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a>& from_codeset)</td></tr> <tr class="memdesc:abb841f9db0731eb8cbc4ea2a8a5d23d5"><td class="mdescLeft"> </td><td class="mdescRight">Open new conversion descriptor. <a href="#abb841f9db0731eb8cbc4ea2a8a5d23d5">More...</a><br /></td></tr> <tr class="separator:abb841f9db0731eb8cbc4ea2a8a5d23d5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae23299525cf67e1c2d4666b4e091f228"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1IConv.html#ae23299525cf67e1c2d4666b4e091f228">IConv</a> (const <a class="el" href="classGlib_1_1IConv.html">IConv</a>&)=delete</td></tr> <tr class="separator:ae23299525cf67e1c2d4666b4e091f228"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a65450c6f04bd3a0f69cd8360c58415d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1IConv.html">IConv</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1IConv.html#a65450c6f04bd3a0f69cd8360c58415d5">operator=</a> (const <a class="el" href="classGlib_1_1IConv.html">IConv</a>&)=delete</td></tr> <tr class="separator:a65450c6f04bd3a0f69cd8360c58415d5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad2722879e0465fec5d9f2c126a602557"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1IConv.html#ad2722879e0465fec5d9f2c126a602557">IConv</a> (GIConv gobject)</td></tr> <tr class="separator:ad2722879e0465fec5d9f2c126a602557"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab56fc0ef68a7f7fee554728a16c6cba0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1IConv.html#ab56fc0ef68a7f7fee554728a16c6cba0">~IConv</a> ()</td></tr> <tr class="memdesc:ab56fc0ef68a7f7fee554728a16c6cba0"><td class="mdescLeft"> </td><td class="mdescRight">Close conversion descriptor. <a href="#ab56fc0ef68a7f7fee554728a16c6cba0">More...</a><br /></td></tr> <tr class="separator:ab56fc0ef68a7f7fee554728a16c6cba0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a094ab3c0fe74ae49968fb7ddfc9372fc"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1IConv.html#a094ab3c0fe74ae49968fb7ddfc9372fc">iconv</a> (char** inbuf, gsize* inbytes_left, char** outbuf, gsize* outbytes_left)</td></tr> <tr class="memdesc:a094ab3c0fe74ae49968fb7ddfc9372fc"><td class="mdescLeft"> </td><td class="mdescRight">Same as the standard UNIX routine iconv(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. <a href="#a094ab3c0fe74ae49968fb7ddfc9372fc">More...</a><br /></td></tr> <tr class="separator:a094ab3c0fe74ae49968fb7ddfc9372fc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab0655474f54dd933d3f6959bdafffabe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1IConv.html#ab0655474f54dd933d3f6959bdafffabe">reset</a> ()</td></tr> <tr class="memdesc:ab0655474f54dd933d3f6959bdafffabe"><td class="mdescLeft"> </td><td class="mdescRight">Reset conversion descriptor to initial state. <a href="#ab0655474f54dd933d3f6959bdafffabe">More...</a><br /></td></tr> <tr class="separator:ab0655474f54dd933d3f6959bdafffabe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a82af42360f040532ebd4b215dc89a59d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01512.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1IConv.html#a82af42360f040532ebd4b215dc89a59d">convert</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01512.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a>& str)</td></tr> <tr class="memdesc:a82af42360f040532ebd4b215dc89a59d"><td class="mdescLeft"> </td><td class="mdescRight">Convert from one encoding to another. <a href="#a82af42360f040532ebd4b215dc89a59d">More...</a><br /></td></tr> <tr class="separator:a82af42360f040532ebd4b215dc89a59d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a12a8c09489388d1efcf9b70586307614"><td class="memItemLeft" align="right" valign="top">GIConv </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1IConv.html#a12a8c09489388d1efcf9b70586307614">gobj</a> ()</td></tr> <tr class="separator:a12a8c09489388d1efcf9b70586307614"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Thin iconv() wrapper. </p> <p>glibmm provides <a class="el" href="group__CharsetConv.html#ga58f7e4556c436a96c64b186bbc8f7f4c" title="Convert from one encoding to another. ">Glib::convert()</a> and <a class="el" href="group__CharsetConv.html#ga4517b17f2aad4cd5c0e0640de212d928" title="Convert from the current locale's encoding to UTF-8. ">Glib::locale_to_utf8()</a> which are likely more convenient than the raw iconv wrappers. However, creating an <a class="el" href="classGlib_1_1IConv.html" title="Thin iconv() wrapper. ">IConv</a> object once and using the <a class="el" href="classGlib_1_1IConv.html#a82af42360f040532ebd4b215dc89a59d" title="Convert from one encoding to another. ">convert()</a> method could be useful when converting multiple times between the same charsets. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="abb841f9db0731eb8cbc4ea2a8a5d23d5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glib::IConv::IConv </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01512.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td> <td class="paramname"><em>to_codeset</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01512.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td> <td class="paramname"><em>from_codeset</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Open new conversion descriptor. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">to_codeset</td><td>Destination codeset. </td></tr> <tr><td class="paramname">from_codeset</td><td>Source codeset. </td></tr> </table> </dd> </dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="classGlib_1_1ConvertError.html" title="Exception class for charset conversion errors. ">Glib::ConvertError</a></td><td></td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ae23299525cf67e1c2d4666b4e091f228"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Glib::IConv::IConv </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGlib_1_1IConv.html">IConv</a>& </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">delete</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ad2722879e0465fec5d9f2c126a602557"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Glib::IConv::IConv </td> <td>(</td> <td class="paramtype">GIConv </td> <td class="paramname"><em>gobject</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">explicit</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ab56fc0ef68a7f7fee554728a16c6cba0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glib::IConv::~IConv </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Close conversion descriptor. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a82af42360f040532ebd4b215dc89a59d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01512.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> Glib::IConv::convert </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01512.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td> <td class="paramname"><em>str</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Convert from one encoding to another. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">str</td><td>The string to convert. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The converted string. </dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="classGlib_1_1ConvertError.html" title="Exception class for charset conversion errors. ">Glib::ConvertError</a></td><td></td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a12a8c09489388d1efcf9b70586307614"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">GIConv Glib::IConv::gobj </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a094ab3c0fe74ae49968fb7ddfc9372fc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::size_t Glib::IConv::iconv </td> <td>(</td> <td class="paramtype">char ** </td> <td class="paramname"><em>inbuf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">gsize * </td> <td class="paramname"><em>inbytes_left</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char ** </td> <td class="paramname"><em>outbuf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">gsize * </td> <td class="paramname"><em>outbytes_left</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Same as the standard UNIX routine iconv(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. </p> <p>glibmm provides <a class="el" href="group__CharsetConv.html#ga58f7e4556c436a96c64b186bbc8f7f4c" title="Convert from one encoding to another. ">Glib::convert()</a> and <a class="el" href="group__CharsetConv.html#ga4517b17f2aad4cd5c0e0640de212d928" title="Convert from the current locale's encoding to UTF-8. ">Glib::locale_to_utf8()</a> which are likely more convenient than the raw iconv wrappers. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">inbuf</td><td><a class="el" href="classGlib_1_1Bytes.html" title="A simple refcounted data type representing an immutable byte sequence from an unspecified origin...">Bytes</a> to convert. </td></tr> <tr><td class="paramname">inbytes_left</td><td>In/out parameter, bytes remaining to convert in <em>inbuf</em>. </td></tr> <tr><td class="paramname">outbuf</td><td>Converted output bytes. </td></tr> <tr><td class="paramname">outbytes_left</td><td>In/out parameter, bytes available to fill in <em>outbuf</em>. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Count of non-reversible conversions, or <code>static_cast<std::size_t>(-1)</code> on error. </dd></dl> </div> </div> <a class="anchor" id="a65450c6f04bd3a0f69cd8360c58415d5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlib_1_1IConv.html">IConv</a>& Glib::IConv::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGlib_1_1IConv.html">IConv</a>& </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">delete</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ab0655474f54dd933d3f6959bdafffabe"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Glib::IConv::reset </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Reset conversion descriptor to initial state. </p> <p>Same as <code>iconv(0, 0, 0, 0)</code>, but implemented slightly differently in order to work on Sun Solaris <= 7. It's also more obvious so you're encouraged to use it. </p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Tue Mar 19 2019 09:56:45 for glibmm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>