/usr/share/gtk-doc/html/libedataserver/libedataserver-EFlag.html is in libedataserver1.2-dev 3.2.3-0ubuntu6.
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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EFlag</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="prev" href="libedataserver-e-debug-log.html" title="e-debug-log">
<link rel="next" href="libedataserver-EIterator.html" title="EIterator">
<meta name="generator" content="GTK-Doc V1.18 (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="libedataserver-e-debug-log.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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-Data-Server Manual: Utilities (libedataserver)</th>
<td><a accesskey="n" href="libedataserver-EIterator.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libedataserver-EFlag.synopsis" class="shortcut">Top</a>
|
<a href="#libedataserver-EFlag.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libedataserver-EFlag"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libedataserver-EFlag.top_of_page"></a>EFlag</span></h2>
<p>EFlag</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libedataserver-EFlag.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag">EFlag</a>;
<a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="returnvalue">EFlag</span></a> * <a class="link" href="libedataserver-EFlag.html#e-flag-new" title="e_flag_new ()">e_flag_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserver-EFlag.html#e-flag-is-set" title="e_flag_is_set ()">e_flag_is_set</a> (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-EFlag.html#e-flag-set" title="e_flag_set ()">e_flag_set</a> (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-EFlag.html#e-flag-clear" title="e_flag_clear ()">e_flag_clear</a> (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-EFlag.html#e-flag-wait" title="e_flag_wait ()">e_flag_wait</a> (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libedataserver-EFlag.html#e-flag-timed-wait" title="e_flag_timed_wait ()">e_flag_timed_wait</a> (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>,
<em class="parameter"><code><span class="type">GTimeVal</span> *abs_time</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-EFlag.html#e-flag-free" title="e_flag_free ()">e_flag_free</a> (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libedataserver-EFlag.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libedataserver-EFlag.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EFlag"></a><h3>EFlag</h3>
<pre class="programlisting">typedef struct _EFlag EFlag;</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
<p class="since">Since 1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="e-flag-new"></a><h3>e_flag_new ()</h3>
<pre class="programlisting"><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="returnvalue">EFlag</span></a> * e_flag_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> object. It is initially unset.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="e-flag-is-set"></a><h3>e_flag_is_set ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_flag_is_set (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);</pre>
<p>
Returns the state of <em class="parameter"><code>flag</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>flag</code></em> is set</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="e-flag-set"></a><h3>e_flag_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_flag_set (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);</pre>
<p>
Sets <em class="parameter"><code>flag</code></em>. All threads waiting on <em class="parameter"><code>flag</code></em> are woken up. Threads that
call <a class="link" href="libedataserver-EFlag.html#e-flag-wait" title="e_flag_wait ()"><code class="function">e_flag_wait()</code></a> or <a class="link" href="libedataserver-EFlag.html#e-flag-timed-wait" title="e_flag_timed_wait ()"><code class="function">e_flag_timed_wait()</code></a> once <em class="parameter"><code>flag</code></em> is set will not
block at all.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="e-flag-clear"></a><h3>e_flag_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_flag_clear (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);</pre>
<p>
Unsets <em class="parameter"><code>flag</code></em>. Subsequent calls to <a class="link" href="libedataserver-EFlag.html#e-flag-wait" title="e_flag_wait ()"><code class="function">e_flag_wait()</code></a> or <a class="link" href="libedataserver-EFlag.html#e-flag-timed-wait" title="e_flag_timed_wait ()"><code class="function">e_flag_timed_wait()</code></a>
will block until <em class="parameter"><code>flag</code></em> is set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="e-flag-wait"></a><h3>e_flag_wait ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_flag_wait (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);</pre>
<p>
Blocks until <em class="parameter"><code>flag</code></em> is set. If <em class="parameter"><code>flag</code></em> is already set, the function returns
immediately.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="e-flag-timed-wait"></a><h3>e_flag_timed_wait ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_flag_timed_wait (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>,
<em class="parameter"><code><span class="type">GTimeVal</span> *abs_time</code></em>);</pre>
<p>
Blocks until <em class="parameter"><code>flag</code></em> is set, or until the time specified by <em class="parameter"><code>abs_time</code></em>.
If <em class="parameter"><code>flag</code></em> is already set, the function returns immediately. The return
value indicates the state of <em class="parameter"><code>flag</code></em> after waiting.
</p>
<p>
If <em class="parameter"><code>abs_time</code></em> is <code class="literal">NULL</code>, <a class="link" href="libedataserver-EFlag.html#e-flag-timed-wait" title="e_flag_timed_wait ()"><code class="function">e_flag_timed_wait()</code></a> acts like <a class="link" href="libedataserver-EFlag.html#e-flag-wait" title="e_flag_wait ()"><code class="function">e_flag_wait()</code></a>.
</p>
<p>
To easily calculate <em class="parameter"><code>abs_time</code></em>, a combination of <code class="function">g_get_current_time()</code> and
<code class="function">g_time_val_add()</code> can be used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>abs_time</code></em> :</span></p></td>
<td>a <span class="type">GTimeVal</span>, determining the final time</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>flag</code></em> is now set</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="e-flag-free"></a><h3>e_flag_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_flag_free (<em class="parameter"><code><a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a> *flag</code></em>);</pre>
<p>
Destroys <em class="parameter"><code>flag</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>flag</code></em> :</span></p></td>
<td>an <a class="link" href="libedataserver-EFlag.html#EFlag" title="EFlag"><span class="type">EFlag</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 1.12</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|