/usr/share/gtk-doc/html/evolution-util/evolution-util-EPoolv.html is in evolution-dev 3.10.4-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EPoolv</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch15.html" title="(Unsorted Sections)">
<link rel="prev" href="EPictureGallery.html" title="EPictureGallery">
<link rel="next" href="EPopupAction.html" title="EPopupAction">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="EPictureGallery.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch15.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution Utilities Reference Manual</th>
<td><a accesskey="n" href="EPopupAction.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#evolution-util-EPoolv.synopsis" class="shortcut">Top</a>
|
<a href="#evolution-util-EPoolv.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="evolution-util-EPoolv"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-util-EPoolv.top_of_page"></a>EPoolv</span></h2>
<p>EPoolv</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="evolution-util-EPoolv.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv">EPoolv</a>;
<a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="returnvalue">EPoolv</span></a> * <a class="link" href="evolution-util-EPoolv.html#e-poolv-new" title="e_poolv_new ()">e_poolv_new</a> (<em class="parameter"><code><span class="type">guint</span> size</code></em>);
<a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="returnvalue">EPoolv</span></a> * <a class="link" href="evolution-util-EPoolv.html#e-poolv-set" title="e_poolv_set ()">e_poolv_set</a> (<em class="parameter"><code><a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="type">EPoolv</span></a> *poolv</code></em>,
<em class="parameter"><code><span class="type">gint</span> index</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *str</code></em>,
<em class="parameter"><code><span class="type">gint</span> freeit</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="evolution-util-EPoolv.html#e-poolv-get" title="e_poolv_get ()">e_poolv_get</a> (<em class="parameter"><code><a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="type">EPoolv</span></a> *poolv</code></em>,
<em class="parameter"><code><span class="type">gint</span> index</code></em>);
<span class="returnvalue">void</span> <a class="link" href="evolution-util-EPoolv.html#e-poolv-destroy" title="e_poolv_destroy ()">e_poolv_destroy</a> (<em class="parameter"><code><a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="type">EPoolv</span></a> *poolv</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="evolution-util-EPoolv.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="evolution-util-EPoolv.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EPoolv"></a><h3>EPoolv</h3>
<pre class="programlisting">typedef struct _EPoolv EPoolv;</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-poolv-new"></a><h3>e_poolv_new ()</h3>
<pre class="programlisting"><a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="returnvalue">EPoolv</span></a> * e_poolv_new (<em class="parameter"><code><span class="type">guint</span> size</code></em>);</pre>
<p>
Create a new <a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="type">EPoolv</span></a>: a string vector which shares a global string
pool. An <a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="type">EPoolv</span></a> can be used to work with arrays of strings which
save memory by eliminating duplicated allocations of the same string.
</p>
<p>
This is useful when you have a log of read-only strings that do not
go away and are duplicated a lot, such as email headers.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>The number of elements in the poolv, maximum of 254 elements.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="type">EPoolv</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-poolv-set"></a><h3>e_poolv_set ()</h3>
<pre class="programlisting"><a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="returnvalue">EPoolv</span></a> * e_poolv_set (<em class="parameter"><code><a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="type">EPoolv</span></a> *poolv</code></em>,
<em class="parameter"><code><span class="type">gint</span> index</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *str</code></em>,
<em class="parameter"><code><span class="type">gint</span> freeit</code></em>);</pre>
<p>
Set a string vector reference. If the caller will no longer be
referencing the string, freeit should be TRUE. Otherwise, this
will duplicate the string if it is not found in the pool.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>poolv</code></em> :</span></p></td>
<td>pooled string vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>index in vector of string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>string to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>freeit</code></em> :</span></p></td>
<td>whether the caller is releasing its reference to the
string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td><em class="parameter"><code>poolv</code></em></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-poolv-get"></a><h3>e_poolv_get ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_poolv_get (<em class="parameter"><code><a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="type">EPoolv</span></a> *poolv</code></em>,
<em class="parameter"><code><span class="type">gint</span> index</code></em>);</pre>
<p>
Retrieve a string by index. This could possibly just be a macro.
</p>
<p>
Since the pool is never freed, this string does not need to be
duplicated, but should not be modified.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>poolv</code></em> :</span></p></td>
<td>pooled string vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>index in vector of string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>string at that index.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-poolv-destroy"></a><h3>e_poolv_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_poolv_destroy (<em class="parameter"><code><a class="link" href="evolution-util-EPoolv.html#EPoolv" title="EPoolv"><span class="type">EPoolv</span></a> *poolv</code></em>);</pre>
<p>
Free a pooled string vector. This doesn't free the strings from
the vector, however.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>poolv</code></em> :</span></p></td>
<td>pooled string vector to free</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|