<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>SphinxBase: include/sphinxbase/mmio.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){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">
<div class="title">mmio.h File Reference</div> </div>
</div><!--header-->
<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 class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ae27ed04d8142d77aae885c8cb8c9fa3b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae27ed04d8142d77aae885c8cb8c9fa3b"></a>
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 class="memdesc:ae27ed04d8142d77aae885c8cb8c9fa3b"><td class="mdescLeft"> </td><td class="mdescRight">Abstract structure representing a memory-mapped file. <br /></td></tr>
<tr class="separator:ae27ed04d8142d77aae885c8cb8c9fa3b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae3367a51a50a6108178ecfdd6c983c61"><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="mmio_8h.html#ae27ed04d8142d77aae885c8cb8c9fa3b">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 class="memdesc:ae3367a51a50a6108178ecfdd6c983c61"><td class="mdescLeft"> </td><td class="mdescRight">Memory-map a file for reading. <a href="#ae3367a51a50a6108178ecfdd6c983c61">More...</a><br /></td></tr>
<tr class="separator:ae3367a51a50a6108178ecfdd6c983c61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e6d8bf5cd7785563abc18c70a31ce0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e6d8bf5cd7785563abc18c70a31ce0d"></a>
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="mmio_8h.html#ae27ed04d8142d77aae885c8cb8c9fa3b">mmio_file_t</a> *mf)</td></tr>
<tr class="memdesc:a5e6d8bf5cd7785563abc18c70a31ce0d"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the memory mapped for a file. <br /></td></tr>
<tr class="separator:a5e6d8bf5cd7785563abc18c70a31ce0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a341a9c1cc8a3c4bddfd2d29a1b0993f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a341a9c1cc8a3c4bddfd2d29a1b0993f6"></a>
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="mmio_8h.html#ae27ed04d8142d77aae885c8cb8c9fa3b">mmio_file_t</a> *mf)</td></tr>
<tr class="memdesc:a341a9c1cc8a3c4bddfd2d29a1b0993f6"><td class="mdescLeft"> </td><td class="mdescRight">Unmap a file, releasing memory associated with it. <br /></td></tr>
<tr class="separator:a341a9c1cc8a3c4bddfd2d29a1b0993f6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Memory-mapped I/O wrappers for files. </p>
<dl class="section author"><dt>Author</dt><dd>David Huggins-Daines <a href="#" onclick="location.href='mai'+'lto:'+'dhu'+'gg'+'ins'+'@c'+'s.c'+'mu'+'.ed'+'u'; return false;">dhugg<span style="display: none;">.nosp@m.</span>ins@<span style="display: none;">.nosp@m.</span>cs.cm<span style="display: none;">.nosp@m.</span>u.ed<span style="display: none;">.nosp@m.</span>u</a> </dd></dl>
<p>Definition in file <a class="el" href="mmio_8h_source.html">mmio.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ae3367a51a50a6108178ecfdd6c983c61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="mmio_8h.html#ae27ed04d8142d77aae885c8cb8c9fa3b">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="section return"><dt>Returns</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>, and <a class="el" href="err_8h_source.html#l00142">E_ERROR_SYSTEM</a>.</p>
<p>Referenced by <a class="el" href="logmath_8c_source.html#l00164">logmath_read()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e3d154c296a8e9be2797a4f81e9375b2.html">sphinxbase</a></li><li class="navelem"><a class="el" href="mmio_8h.html">mmio.h</a></li>
<li class="footer">Generated on Sat Oct 18 2014 15:21:17 for SphinxBase by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
b56c9eed3fa0f00740b6f09a2460a97f
>
files
>
344
