<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>SphinxBase: include/sphinxbase/mmio.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SphinxBase <span id="projectnumber">0.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('mmio_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>include/sphinxbase/mmio.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Memory-mapped I/O wrappers for files.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <sphinxbase/sphinxbase_export.h></code><br/>
</div>
<p><a href="mmio_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae27ed04d8142d77aae885c8cb8c9fa3b"></a><!-- doxytag: member="mmio.h::mmio_file_t" ref="ae27ed04d8142d77aae885c8cb8c9fa3b" args="" -->
typedef struct <a class="el" href="structmmio__file__s.html">mmio_file_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mmio_8h.html#ae27ed04d8142d77aae885c8cb8c9fa3b">mmio_file_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abstract structure representing a memory-mapped file. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structmmio__file__s.html">mmio_file_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mmio_8h.html#ae3367a51a50a6108178ecfdd6c983c61">mmio_file_read</a> (const char *filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Memory-map a file for reading. <a href="#ae3367a51a50a6108178ecfdd6c983c61"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e6d8bf5cd7785563abc18c70a31ce0d"></a><!-- doxytag: member="mmio.h::mmio_file_ptr" ref="a5e6d8bf5cd7785563abc18c70a31ce0d" args="(mmio_file_t *mf)" -->
SPHINXBASE_EXPORT void * </td><td class="memItemRight" valign="bottom"><a class="el" href="mmio_8h.html#a5e6d8bf5cd7785563abc18c70a31ce0d">mmio_file_ptr</a> (<a class="el" href="structmmio__file__s.html">mmio_file_t</a> *mf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the memory mapped for a file. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a341a9c1cc8a3c4bddfd2d29a1b0993f6"></a><!-- doxytag: member="mmio.h::mmio_file_unmap" ref="a341a9c1cc8a3c4bddfd2d29a1b0993f6" args="(mmio_file_t *mf)" -->
SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="mmio_8h.html#a341a9c1cc8a3c4bddfd2d29a1b0993f6">mmio_file_unmap</a> (<a class="el" href="structmmio__file__s.html">mmio_file_t</a> *mf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unmap a file, releasing memory associated with it. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Memory-mapped I/O wrappers for files. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Huggins-Daines <<a href="mailto:dhuggins@cs.cmu.edu">dhuggins@cs.cmu.edu</a>> </dd></dl>
<p>Definition in file <a class="el" href="mmio_8h_source.html">mmio.h</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae3367a51a50a6108178ecfdd6c983c61"></a><!-- doxytag: member="mmio.h::mmio_file_read" ref="ae3367a51a50a6108178ecfdd6c983c61" args="(const char *filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="structmmio__file__s.html">mmio_file_t</a>* mmio_file_read </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Memory-map a file for reading. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a mmio_file_t * or NULL for failure. </dd></dl>
<p>Definition at line <a class="el" href="mmio_8c_source.html#l00206">206</a> of file <a class="el" href="mmio_8c_source.html">mmio.c</a>.</p>
<p>References <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, <a class="el" href="err_8h_source.html#l00142">E_ERROR_SYSTEM</a>, and <a class="el" href="mmio_8c_source.html#l00206">mmio_file_read()</a>.</p>
<p>Referenced by <a class="el" href="logmath_8c_source.html#l00164">logmath_read()</a>, and <a class="el" href="mmio_8c_source.html#l00206">mmio_file_read()</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="mmio_8h.html">mmio.h</a> </li>
<li class="footer">Generated on Tue Apr 19 2011 for SphinxBase by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
0b420d0fce195cf4115dc6a3be5c2da2
>
files
>
285
