project/captive/apiref/captive-apiref-init.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>init</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><meta name="generator" content="GTK-Doc V1.1 (XML mode)"><style type="text/css">
   3         .synopsis, .classsynopsis {
   4             background: #eeeeee;
   5             border: solid 1px #aaaaaa;
   6             padding: 0.5em;
   7         }
   8         .programlisting {
   9             background: #eeeeff;
  10             border: solid 1px #aaaaff;
  11             padding: 0.5em;
  12         }
  13         .variablelist {
  14             padding: 4px;
  15             margin-left: 3em;
  16         }
  17         .navigation {
  18             background: #ffeeee;
  19             border: solid 1px #ffaaaa;
  20             margin-top: 0.5em;
  21             margin-bottom: 0.5em;
  22         }
  23         .navigation a {
  24             color: #770000;
  25         }
  26         .navigation a:visited {
  27             color: #550000;
  28         }
  29         .navigation .title {
  30             font-size: 200%;
  31         }
  32       </style><link rel="home" href="index.html" title="Operation Captive Reference Manual"><link rel="up" href="ch01.html" title="Operation Captive"><link rel="previous" href="ch01.html" title="Operation Captive"><link rel="next" href="captive-apiref-ldr.html" title="ldr"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="ch01.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">Operation Captive Reference Manual</th><td><a accesskey="n" href="captive-apiref-ldr.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="captive-apiref-init"></a><div class="titlepage"></div><div class="refnamediv"><h2>init</h2><p>init &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  33
  34
  35
  36 gboolean    <a href="captive-apiref-init.html#captive-init">captive_init</a>                    (void);
  37 gboolean    <a href="captive-apiref-init.html#captive-shutdown">captive_shutdown</a>                (void);
  38 void        <a href="captive-apiref-init.html#captive-log-init">captive_log_init</a>                (const struct captive_options *captive_options);
  39 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
  40
  41 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="captive-init"></a>captive_init ()</h3><pre class="programlisting">gboolean    captive_init                    (void);</pre><p>
  42 Expects captive_options: Parsed by captive_options_parse().
  43 <tt>NULL</tt> value is forbidden. Field image_iochannel <tt>NULL</tt> value is forbidden.
  44 </p><p>
  45 Initializes <tt>libcaptive</tt> and loads the specified filesystem.</p><p>
  46
  47 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt>TRUE</tt> if successfuly initialized.
  48 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="captive-shutdown"></a>captive_shutdown ()</h3><pre class="programlisting">gboolean    captive_shutdown                (void);</pre><p>
  49 Closes down <tt>libcaptive</tt>. It should flush all pending buffers and successfuly
  50 close the filesystem. Variable captive_options-&gt;image_iochannel will not be set to <tt>NULL</tt>,
  51 you should close such channel yourself.</p><p>
  52
  53 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt>TRUE</tt> if successfuly shutdown.
  54 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="captive-log-init"></a>captive_log_init ()</h3><pre class="programlisting">void        captive_log_init                (const struct captive_options *captive_options);</pre><p>
  55
  56 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>captive_options</tt></i> :</span></td><td>
  57
  58
  59 </td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="ch01.html"><b>&lt;&lt; Operation Captive</b></a></td><td align="right"><a accesskey="n" href="captive-apiref-ldr.html"><b>ldr &gt;&gt;</b></a></td></tr></table></body></html>