/usr/share/gtk-doc/html/gcab/gcab-GCabFolder.html is in libgcab-doc 1.1-2.
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 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GCabFolder: GCab Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GCab Reference Manual">
<link rel="up" href="ch01.html" title="Cabinet API">
<link rel="prev" href="gcab-GCabCabinet.html" title="GCabCabinet">
<link rel="next" href="gcab-GCabFile.html" title="GCabFile">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gcab-GCabFolder.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gcab-GCabCabinet.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gcab-GCabFile.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gcab-GCabFolder"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gcab-GCabFolder.top_of_page"></a>GCabFolder</span></h2>
<p>GCabFolder — A Cabinet folder</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gcab-GCabFolder.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="gcab-GCabFolder.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="returnvalue">GCabFolder</span></a> *
</td>
<td class="function_name">
<a class="link" href="gcab-GCabFolder.html#gcab-folder-new" title="gcab_folder_new ()">gcab_folder_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gcab-GCabFolder.html#gcab-folder-add-file" title="gcab_folder_add_file ()">gcab_folder_add_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GSList</span> *
</td>
<td class="function_name">
<a class="link" href="gcab-GCabFolder.html#gcab-folder-get-files" title="gcab_folder_get_files ()">gcab_folder_get_files</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="gcab-GCabFolder.html#gcab-folder-get-nfiles" title="gcab_folder_get_nfiles ()">gcab_folder_get_nfiles</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="gcab-GCabFolder.html#gcab-folder-get-comptype" title="gcab_folder_get_comptype ()">gcab_folder_get_comptype</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gcab-GCabFile.html#GCabFile" title="GCabFile"><span class="returnvalue">GCabFile</span></a> *
</td>
<td class="function_name">
<a class="link" href="gcab-GCabFolder.html#gcab-folder-get-file-by-name" title="gcab_folder_get_file_by_name ()">gcab_folder_get_file_by_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gcab-GCabFolder.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gcab-GCabFolder.html#GCabCompression" title="enum GCabCompression">GCabCompression</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder">GCabFolder</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gcab-GCabFolder.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libgcab.h>
</pre>
</div>
<div class="refsect1">
<a name="gcab-GCabFolder.description"></a><h2>Description</h2>
<p>A GCabFolder is a handle to a folder within the Cabinet archive. A
Cabinet folder <span class="emphasis"><em>is not</em></span> like a directory. It is
a sub-container grouping GCabFiles together, sharing some common
settings like the compression method.</p>
<p>You can retrieve the files within a folder with
<a class="link" href="gcab-GCabFolder.html#gcab-folder-get-files" title="gcab_folder_get_files ()"><code class="function">gcab_folder_get_files()</code></a>.</p>
<p>In order to add a file to a folder for creation, use
<a class="link" href="gcab-GCabFolder.html#gcab-folder-add-file" title="gcab_folder_add_file ()"><code class="function">gcab_folder_add_file()</code></a>.</p>
</div>
<div class="refsect1">
<a name="gcab-GCabFolder.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gcab-folder-new"></a><h3>gcab_folder_new ()</h3>
<pre class="programlisting"><a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="returnvalue">GCabFolder</span></a> *
gcab_folder_new (<em class="parameter"><code><span class="type">gint</span> comptype</code></em>);</pre>
<p>Creates a new empty Cabinet folder. Use <a class="link" href="gcab-GCabFolder.html#gcab-folder-add-file" title="gcab_folder_add_file ()"><code class="function">gcab_folder_add_file()</code></a> to
add files to an archive.</p>
<p>A Cabinet folder is not a file path, it is a container for files.</p>
<div class="refsect3">
<a name="gcab-folder-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>comptype</p></td>
<td class="parameter_description"><p>compression to used in this folder</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcab-folder-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcab-folder-add-file"></a><h3>gcab_folder_add_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gcab_folder_add_file (<em class="parameter"><code><a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a> *cabfolder</code></em>,
<em class="parameter"><code><a class="link" href="gcab-GCabFile.html#GCabFile" title="GCabFile"><span class="type">GCabFile</span></a> *cabfile</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> recurse</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Add <em class="parameter"><code>file</code></em>
to the <a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a>.</p>
<div class="refsect3">
<a name="gcab-folder-add-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cabfolder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cabfile</p></td>
<td class="parameter_description"><p>file to be added</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>recurse</p></td>
<td class="parameter_description"><p>whether to recurse through subdirectories</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <span class="type">GCancellable</span> object,
<code class="literal">NULL</code> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> <span class="type">GError</span> to set on error, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcab-folder-add-file.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on succes</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcab-folder-get-files"></a><h3>gcab_folder_get_files ()</h3>
<pre class="programlisting"><span class="returnvalue">GSList</span> *
gcab_folder_get_files (<em class="parameter"><code><a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a> *cabfolder</code></em>);</pre>
<p>Get the list of <a class="link" href="gcab-GCabFile.html#GCabFile" title="GCabFile"><span class="type">GCabFile</span></a> files contained in the <em class="parameter"><code>cabfolder</code></em>
.</p>
<div class="refsect3">
<a name="gcab-folder-get-files.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cabfolder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcab-folder-get-files.returns"></a><h4>Returns</h4>
<p> list of files. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GCabFile][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcab-folder-get-nfiles"></a><h3>gcab_folder_get_nfiles ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gcab_folder_get_nfiles (<em class="parameter"><code><a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a> *cabfolder</code></em>);</pre>
<p>Get the number of files in this <em class="parameter"><code>folder</code></em>
.</p>
<div class="refsect3">
<a name="gcab-folder-get-nfiles.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cabfolder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcab-folder-get-nfiles.returns"></a><h4>Returns</h4>
<p> a <span class="type">guint</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcab-folder-get-comptype"></a><h3>gcab_folder_get_comptype ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gcab_folder_get_comptype (<em class="parameter"><code><a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a> *cabfolder</code></em>);</pre>
<p>Returns the compression used in this folder.</p>
<div class="refsect3">
<a name="gcab-folder-get-comptype.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cabfolder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcab-folder-get-comptype.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="gcab-GCabFolder.html#GCabCompression" title="enum GCabCompression"><span class="type">GCabCompression</span></a>, e.g. <a class="link" href="gcab-GCabFolder.html#GCAB-COMPRESSION-MSZIP:CAPS"><code class="literal">GCAB_COMPRESSION_MSZIP</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-0.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gcab-folder-get-file-by-name"></a><h3>gcab_folder_get_file_by_name ()</h3>
<pre class="programlisting"><a class="link" href="gcab-GCabFile.html#GCabFile" title="GCabFile"><span class="returnvalue">GCabFile</span></a> *
gcab_folder_get_file_by_name (<em class="parameter"><code><a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a> *cabfolder</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Gets a specific <a class="link" href="gcab-GCabFile.html#GCabFile" title="GCabFile"><span class="type">GCabFile</span></a> files contained in the <em class="parameter"><code>cabfolder</code></em>
.</p>
<div class="refsect3">
<a name="gcab-folder-get-file-by-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cabfolder</p></td>
<td class="parameter_description"><p>a <a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>a file name</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcab-folder-get-file-by-name.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="gcab-GCabFile.html#GCabFile" title="GCabFile"><span class="type">GCabFile</span></a>, or <code class="literal">NULL</code> if not found. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gcab-GCabFolder.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GCabCompression"></a><h3>enum GCabCompression</h3>
<p>Compression used by the <a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a>.</p>
<div class="refsect3">
<a name="GCabCompression.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GCAB-COMPRESSION-NONE:CAPS"></a>GCAB_COMPRESSION_NONE</p></td>
<td class="enum_member_description">
<p>No compression.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCAB-COMPRESSION-MSZIP:CAPS"></a>GCAB_COMPRESSION_MSZIP</p></td>
<td class="enum_member_description">
<p>MSZIP compression.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCAB-COMPRESSION-QUANTUM:CAPS"></a>GCAB_COMPRESSION_QUANTUM</p></td>
<td class="enum_member_description">
<p>QUANTUM compression (unsupported).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCAB-COMPRESSION-LZX:CAPS"></a>GCAB_COMPRESSION_LZX</p></td>
<td class="enum_member_description">
<p>LZX compression (only decompression supported).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCAB-COMPRESSION-MASK:CAPS"></a>GCAB_COMPRESSION_MASK</p></td>
<td class="enum_member_description">
<p>compression value mask.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GCabFolder"></a><h3>GCabFolder</h3>
<pre class="programlisting">typedef struct _GCabFolder GCabFolder;</pre>
<p>An opaque object, referencing a folder in a Cabinet.</p>
</div>
</div>
<div class="refsect1">
<a name="gcab-GCabFolder.see-also"></a><h2>See Also</h2>
<p><a class="link" href="gcab-GCabFolder.html#GCabFolder" title="GCabFolder"><span class="type">GCabFolder</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|