project/captive/apiref/captive-apiref-rtl-file.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>rtl-file</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="captive-apiref-signal.html" title="signal"></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="captive-apiref-signal.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></tr></table><div class="refentry" lang="en"><a name="captive-apiref-rtl-file"></a><div class="titlepage"></div><div class="refnamediv"><h2>rtl-file</h2><p>rtl-file &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  33
  34
  35
  36 gpointer    <a href="captive-apiref-rtl-file.html#captive-rtl-file-mmap">captive_rtl_file_mmap</a>           (size_t *lenp,
  37                                              const gchar *path,
  38                                              int open_flags,
  39                                              int mmap_prot,
  40                                              int mmap_flags);
  41 void        <a href="captive-apiref-rtl-file.html#captive-rtl-file-munmap">captive_rtl_file_munmap</a>         (gpointer base);
  42 gpointer    <a href="captive-apiref-rtl-file.html#captive-rtl-file-read">captive_rtl_file_read</a>           (gint fd,
  43                                              gsize *bufsizep);
  44 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
  45
  46 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="captive-rtl-file-mmap"></a>captive_rtl_file_mmap ()</h3><pre class="programlisting">gpointer    captive_rtl_file_mmap           (size_t *lenp,
  47                                              const gchar *path,
  48                                              int open_flags,
  49                                              int mmap_prot,
  50                                              int mmap_flags);</pre><p>
  51 mmap(2) the whole file into memory.</p><p>
  52
  53 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>lenp</tt></i> :</span></td><td> returns the file length if successful. <tt>NULL</tt> pointer permitted.
  54 </td></tr><tr><td><span class="term"><i><tt>path</tt></i> :</span></td><td> File pathname to open(2).
  55 </td></tr><tr><td><span class="term"><i><tt>open_flags</tt></i> :</span></td><td> open(2) parameter flags such as <tt>O_RDONLY</tt>.
  56 </td></tr><tr><td><span class="term"><i><tt>mmap_prot</tt></i> :</span></td><td> mmap(2) parameter prot such as <tt>PROT_READ</tt>.
  57 </td></tr><tr><td><span class="term"><i><tt>mmap_flags</tt></i> :</span></td><td> mmap(2) parameter flags such as <tt>MAP_SHARED</tt>.
  58 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> address base with mmap(2)ed file (and <i><tt>lenp</tt></i> filled) or NULL if error.
  59 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="captive-rtl-file-munmap"></a>captive_rtl_file_munmap ()</h3><pre class="programlisting">void        captive_rtl_file_munmap         (gpointer base);</pre><p>
  60 munmap(2) the whole file and destroy all its resources.</p><p>
  61
  62 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>base</tt></i> :</span></td><td> file base address returned by <a href="captive-apiref-rtl-file.html#captive-rtl-file-mmap">captive_rtl_file_mmap</a>(). <tt>NULL</tt> pointer forbidden.
  63 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="captive-rtl-file-read"></a>captive_rtl_file_read ()</h3><pre class="programlisting">gpointer    captive_rtl_file_read           (gint fd,
  64                                              gsize *bufsizep);</pre><p>
  65 Reads the whole file into memory.</p><p>
  66
  67 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>fd</tt></i> :</span></td><td> file-descriptor to read data from.
  68 </td></tr><tr><td><span class="term"><i><tt>bufsizep</tt></i> :</span></td><td> Returns the size of resulting data.
  69 <tt>NULL</tt> pointer is permitted.
  70 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> address base of the memory being filled with file contents.
  71 Free the area by g_free() if no longer used.
  72 </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="captive-apiref-signal.html"><b>&lt;&lt; signal</b></a></td><td align="right"></td></tr></table></body></html>