/usr/share/gtk-doc/html/PackageKit/PackageKit-pk-bitfield.html is in packagekit-docs 0.7.6-3.
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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>pk-bitfield</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="PackageKit Reference Manual">
<link rel="up" href="libpackagekit-helpers.html" title="libpackagekit glib helpers">
<link rel="prev" href="libpackagekit-helpers.html" title="libpackagekit glib helpers">
<link rel="next" href="PackageKit-pk-client-sync.html" title="pk-client-sync">
<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="libpackagekit-helpers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libpackagekit-helpers.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">PackageKit Reference Manual</th>
<td><a accesskey="n" href="PackageKit-pk-client-sync.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PackageKit-pk-bitfield.synopsis" class="shortcut">Top</a>
|
<a href="#PackageKit-pk-bitfield.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="PackageKit-pk-bitfield"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PackageKit-pk-bitfield.top_of_page"></a>pk-bitfield</span></h2>
<p>pk-bitfield</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PackageKit-pk-bitfield.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="PackageKit-pk-bitfield.html#PK-BITFIELD-FORMAT:CAPS" title="PK_BITFIELD_FORMAT">PK_BITFIELD_FORMAT</a>
typedef <a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield">PkBitfield</a>;
#define <a class="link" href="PackageKit-pk-bitfield.html#pk-bitfield-add" title="pk_bitfield_add()">pk_bitfield_add</a> (bitfield,
enum)
#define <a class="link" href="PackageKit-pk-bitfield.html#pk-bitfield-contain" title="pk_bitfield_contain()">pk_bitfield_contain</a> (bitfield,
enum)
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="PackageKit-pk-bitfield.html#pk-bitfield-contain-priority" title="pk_bitfield_contain_priority ()">pk_bitfield_contain_priority</a> (<em class="parameter"><code><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="type">PkBitfield</span></a> values</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>,
<em class="parameter"><code>...</code></em>);
<a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="returnvalue">PkBitfield</span></a> <a class="link" href="PackageKit-pk-bitfield.html#pk-bitfield-from-enums" title="pk_bitfield_from_enums ()">pk_bitfield_from_enums</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>,
<em class="parameter"><code>...</code></em>);
#define <a class="link" href="PackageKit-pk-bitfield.html#pk-bitfield-invert" title="pk_bitfield_invert()">pk_bitfield_invert</a> (bitfield,
enum)
#define <a class="link" href="PackageKit-pk-bitfield.html#pk-bitfield-remove" title="pk_bitfield_remove()">pk_bitfield_remove</a> (bitfield,
enum)
<span class="returnvalue">void</span> <a class="link" href="PackageKit-pk-bitfield.html#pk-bitfield-test" title="pk_bitfield_test ()">pk_bitfield_test</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
#define <a class="link" href="PackageKit-pk-bitfield.html#pk-bitfield-value" title="pk_bitfield_value()">pk_bitfield_value</a> (enum)
<a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="returnvalue">PkBitfield</span></a> <a class="link" href="PackageKit-pk-bitfield.html#pk-filter-bitfield-from-string" title="pk_filter_bitfield_from_string ()">pk_filter_bitfield_from_string</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filters</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="PackageKit-pk-bitfield.html#pk-filter-bitfield-to-string" title="pk_filter_bitfield_to_string ()">pk_filter_bitfield_to_string</a> (<em class="parameter"><code><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="type">PkBitfield</span></a> filters</code></em>);
<a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="returnvalue">PkBitfield</span></a> <a class="link" href="PackageKit-pk-bitfield.html#pk-group-bitfield-from-string" title="pk_group_bitfield_from_string ()">pk_group_bitfield_from_string</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *groups</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="PackageKit-pk-bitfield.html#pk-group-bitfield-to-string" title="pk_group_bitfield_to_string ()">pk_group_bitfield_to_string</a> (<em class="parameter"><code><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="type">PkBitfield</span></a> groups</code></em>);
<a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="returnvalue">PkBitfield</span></a> <a class="link" href="PackageKit-pk-bitfield.html#pk-role-bitfield-from-string" title="pk_role_bitfield_from_string ()">pk_role_bitfield_from_string</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *roles</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="PackageKit-pk-bitfield.html#pk-role-bitfield-to-string" title="pk_role_bitfield_to_string ()">pk_role_bitfield_to_string</a> (<em class="parameter"><code><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="type">PkBitfield</span></a> roles</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PackageKit-pk-bitfield.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="PackageKit-pk-bitfield.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="PK-BITFIELD-FORMAT:CAPS"></a><h3>PK_BITFIELD_FORMAT</h3>
<pre class="programlisting">#define PK_BITFIELD_FORMAT G_GUINT64_FORMAT
</pre>
</div>
<hr>
<div class="refsect2">
<a name="PkBitfield"></a><h3>PkBitfield</h3>
<pre class="programlisting">typedef guint64 PkBitfield;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-bitfield-add"></a><h3>pk_bitfield_add()</h3>
<pre class="programlisting">#define pk_bitfield_add(bitfield,enum) do { ((bitfield) |= (pk_bitfield_value(enum))); } while (0)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-bitfield-contain"></a><h3>pk_bitfield_contain()</h3>
<pre class="programlisting">#define pk_bitfield_contain(bitfield,enum) (((bitfield) & (pk_bitfield_value(enum))) > 0)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-bitfield-contain-priority"></a><h3>pk_bitfield_contain_priority ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> pk_bitfield_contain_priority (<em class="parameter"><code><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="type">PkBitfield</span></a> values</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Finds elements in a list, but with priority going to the preceeding entry
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>values</code></em> :</span></p></td>
<td>a valid bitfield instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the values we are searching for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The return enumerated type, or -1 if none are found</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.2</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-bitfield-from-enums"></a><h3>pk_bitfield_from_enums ()</h3>
<pre class="programlisting"><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="returnvalue">PkBitfield</span></a> pk_bitfield_from_enums (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the values we want to add to the bitfield</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The return bitfield, or 0 if invalid</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.2</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-bitfield-invert"></a><h3>pk_bitfield_invert()</h3>
<pre class="programlisting">#define pk_bitfield_invert(bitfield,enum) do { ((bitfield) ^= (pk_bitfield_value(enum))); } while (0)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-bitfield-remove"></a><h3>pk_bitfield_remove()</h3>
<pre class="programlisting">#define pk_bitfield_remove(bitfield,enum) do { ((bitfield) &= ~(pk_bitfield_value(enum))); } while (0)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-bitfield-test"></a><h3>pk_bitfield_test ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> pk_bitfield_test (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-bitfield-value"></a><h3>pk_bitfield_value()</h3>
<pre class="programlisting">#define pk_bitfield_value(enum) ((PkBitfield) 1 << (enum))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-filter-bitfield-from-string"></a><h3>pk_filter_bitfield_from_string ()</h3>
<pre class="programlisting"><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="returnvalue">PkBitfield</span></a> pk_filter_bitfield_from_string (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filters</code></em>);</pre>
<p>
Converts text representation to its enumerated type bitfield, or 0 for invalid
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filters</code></em> :</span></p></td>
<td>the enumerated constant value, e.g. "available;~gui"</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The enumerated type values</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.2</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-filter-bitfield-to-string"></a><h3>pk_filter_bitfield_to_string ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * pk_filter_bitfield_to_string (<em class="parameter"><code><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="type">PkBitfield</span></a> filters</code></em>);</pre>
<p>
Converts a enumerated type bitfield to its text representation
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filters</code></em> :</span></p></td>
<td>The enumerated type values</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the enumerated constant value, e.g. "available;~gui"</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.2</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-group-bitfield-from-string"></a><h3>pk_group_bitfield_from_string ()</h3>
<pre class="programlisting"><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="returnvalue">PkBitfield</span></a> pk_group_bitfield_from_string (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *groups</code></em>);</pre>
<p>
Converts text representation to its enumerated type bitfield
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>groups</code></em> :</span></p></td>
<td>the enumerated constant value, e.g. "available;~gui"</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The enumerated type values, or 0 for invalid</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.2</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-group-bitfield-to-string"></a><h3>pk_group_bitfield_to_string ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * pk_group_bitfield_to_string (<em class="parameter"><code><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="type">PkBitfield</span></a> groups</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-role-bitfield-from-string"></a><h3>pk_role_bitfield_from_string ()</h3>
<pre class="programlisting"><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="returnvalue">PkBitfield</span></a> pk_role_bitfield_from_string (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *roles</code></em>);</pre>
<p>
Converts text representation to its enumerated type bitfield
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>roles</code></em> :</span></p></td>
<td>the enumerated constant value, e.g. "search-file;update-system"</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The enumerated type values, or 0 for invalid</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.2</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-role-bitfield-to-string"></a><h3>pk_role_bitfield_to_string ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * pk_role_bitfield_to_string (<em class="parameter"><code><a class="link" href="PackageKit-pk-bitfield.html#PkBitfield" title="PkBitfield"><span class="type">PkBitfield</span></a> roles</code></em>);</pre>
<p>
Converts a enumerated type bitfield to its text representation
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>roles</code></em> :</span></p></td>
<td>The enumerated type values</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the enumerated constant value, e.g. "install-file;update-system"</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|