<!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.8"/>
<title>Geany: encodings.h File 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" />
</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">Geany
 <span id="projectnumber">1.24.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<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="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">encodings.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Encoding conversion and Byte Order Mark (BOM) handling.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structGeanyEncoding.html">GeanyEncoding</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure to represent an encoding to be used in Geany. <a href="structGeanyEncoding.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a21ed71283ad35080ee536dbc2a8a99a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21ed71283ad35080ee536dbc2a8a99a3"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="encodings_8h.html#a21ed71283ad35080ee536dbc2a8a99a3">GeanyEncodingIndex</a> </td></tr>
<tr class="memdesc:a21ed71283ad35080ee536dbc2a8a99a3"><td class="mdescLeft"> </td><td class="mdescRight">List of known and supported encodings. <br /></td></tr>
<tr class="separator:a21ed71283ad35080ee536dbc2a8a99a3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a135582b8a0d37167f22f32f2511c4862"><td class="memItemLeft" align="right" valign="top">gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="encodings_8h.html#a135582b8a0d37167f22f32f2511c4862">encodings_convert_to_utf8</a> (const gchar *buffer, gssize size, gchar **used_encoding)</td></tr>
<tr class="memdesc:a135582b8a0d37167f22f32f2511c4862"><td class="mdescLeft"> </td><td class="mdescRight">Tries to convert <em>buffer</em> into UTF-8 encoding and store the detected original encoding in <em>used_encoding</em>. <a href="#a135582b8a0d37167f22f32f2511c4862">More...</a><br /></td></tr>
<tr class="separator:a135582b8a0d37167f22f32f2511c4862"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6c3f31418b1c653d1c70d4a40dda6f2"><td class="memItemLeft" align="right" valign="top">gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="encodings_8h.html#aa6c3f31418b1c653d1c70d4a40dda6f2">encodings_convert_to_utf8_from_charset</a> (const gchar *buffer, gssize size, const gchar *charset, gboolean fast)</td></tr>
<tr class="memdesc:aa6c3f31418b1c653d1c70d4a40dda6f2"><td class="mdescLeft"> </td><td class="mdescRight">Tries to convert <em>buffer</em> into UTF-8 encoding from the encoding specified with <em>charset</em>. <a href="#aa6c3f31418b1c653d1c70d4a40dda6f2">More...</a><br /></td></tr>
<tr class="separator:aa6c3f31418b1c653d1c70d4a40dda6f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91d89ed4c575f252e4ac224f4fe273a5"><td class="memItemLeft" align="right" valign="top">const gchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="encodings_8h.html#a91d89ed4c575f252e4ac224f4fe273a5">encodings_get_charset_from_index</a> (gint idx)</td></tr>
<tr class="memdesc:a91d89ed4c575f252e4ac224f4fe273a5"><td class="mdescLeft"> </td><td class="mdescRight">Gets the character set name of the specified index e.g. <a href="#a91d89ed4c575f252e4ac224f4fe273a5">More...</a><br /></td></tr>
<tr class="separator:a91d89ed4c575f252e4ac224f4fe273a5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Encoding conversion and Byte Order Mark (BOM) handling. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a135582b8a0d37167f22f32f2511c4862"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gchar* encodings_convert_to_utf8 </td>
<td>(</td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gssize </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gchar ** </td>
<td class="paramname"><em>used_encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to convert <em>buffer</em> into UTF-8 encoding and store the detected original encoding in <em>used_encoding</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>the input string to convert. </td></tr>
<tr><td class="paramname">size</td><td>the length of the string, or -1 if the string is nul-terminated. </td></tr>
<tr><td class="paramname">used_encoding</td><td>return location of the detected encoding of the input string, or <code>NULL</code>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the conversion was successful, a newly allocated nul-terminated string, which must be freed with <code>g_free()</code>. Otherwise <code>NULL</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="aa6c3f31418b1c653d1c70d4a40dda6f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gchar* encodings_convert_to_utf8_from_charset </td>
<td>(</td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gssize </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gchar * </td>
<td class="paramname"><em>charset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gboolean </td>
<td class="paramname"><em>fast</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to convert <em>buffer</em> into UTF-8 encoding from the encoding specified with <em>charset</em>. </p>
<p>If <em>fast</em> is not set, additional checks to validate the converted string are performed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>The input string to convert. </td></tr>
<tr><td class="paramname">size</td><td>The length of the string, or -1 if the string is nul-terminated. </td></tr>
<tr><td class="paramname">charset</td><td>The charset to be used for conversion. </td></tr>
<tr><td class="paramname">fast</td><td><code>TRUE</code> to only convert the input and skip extended checks on the converted string.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the conversion was successful, a newly allocated nul-terminated string, which must be freed with <code>g_free()</code>. Otherwise <code>NULL</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a91d89ed4c575f252e4ac224f4fe273a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const gchar* encodings_get_charset_from_index </td>
<td>(</td>
<td class="paramtype">gint </td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the character set name of the specified index e.g. </p>
<p>for use with <a class="el" href="document_8h.html#a3aea9e2f1c8205618e105dabb2c021dd">document_set_encoding()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td><a class="el" href="encodings_8h.html#a21ed71283ad35080ee536dbc2a8a99a3">GeanyEncodingIndex</a> to retrieve the corresponding character set.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The charset according to idx, or <code>NULL</code> if the index is invalid.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.13 </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 17 2014 05:13:17 for Geany by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
0c00422fba9a46710101d04f3f3175e7
>
files
>
61
