<!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>nifti1_io: /builddir/build/BUILD/nifticlib-2.0.0/znzlib/znzlib.c File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.4 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <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">nifti1_io</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="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </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>File Members</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#define-members">Defines</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">/builddir/build/BUILD/nifticlib-2.0.0/znzlib/znzlib.c File Reference</div> </div> </div> <div class="contents"> <p>Low level i/o interface to compressed and noncompressed files. Written by Mark Jenkinson, FMRIB. <a href="#details">More...</a></p> <div class="textblock"><code>#include "znzlib.h"</code><br/> </div><table class="memberdecls"> <tr><td colspan="2"><h2><a name="define-members"></a> Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a704d5acdeafe9b3ba8bfe00a00bc5ce5"></a><!-- doxytag: member="znzlib.c::ZNZ_MAX_BLOCK_SIZE" ref="a704d5acdeafe9b3ba8bfe00a00bc5ce5" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>ZNZ_MAX_BLOCK_SIZE</b>   (1<<30)</td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa540bce560a7e7cb664834919aaa22c3"></a><!-- doxytag: member="znzlib.c::znzopen" ref="aa540bce560a7e7cb664834919aaa22c3" args="(const char *path, const char *mode, int use_compression)" --> <a class="el" href="structznzptr.html">znzFile</a> </td><td class="memItemRight" valign="bottom"><b>znzopen</b> (const char *path, const char *mode, int use_compression)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1787892db58f5a7cd52e277afaaeb047"></a><!-- doxytag: member="znzlib.c::znzdopen" ref="a1787892db58f5a7cd52e277afaaeb047" args="(int fd, const char *mode, int use_compression)" --> <a class="el" href="structznzptr.html">znzFile</a> </td><td class="memItemRight" valign="bottom"><b>znzdopen</b> (int fd, const char *mode, int use_compression)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52af94f6a3c8f0b049f0da23a73298b2"></a><!-- doxytag: member="znzlib.c::Xznzclose" ref="a52af94f6a3c8f0b049f0da23a73298b2" args="(znzFile *file)" --> int </td><td class="memItemRight" valign="bottom"><b>Xznzclose</b> (<a class="el" href="structznzptr.html">znzFile</a> *file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb8e9e6f545a5feaa67d680acdc55d36"></a><!-- doxytag: member="znzlib.c::znzread" ref="aeb8e9e6f545a5feaa67d680acdc55d36" args="(void *buf, size_t size, size_t nmemb, znzFile file)" --> size_t </td><td class="memItemRight" valign="bottom"><b>znzread</b> (void *buf, size_t size, size_t nmemb, <a class="el" href="structznzptr.html">znzFile</a> file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a983f55a92768766161deb0235e0cd4"></a><!-- doxytag: member="znzlib.c::znzwrite" ref="a3a983f55a92768766161deb0235e0cd4" args="(const void *buf, size_t size, size_t nmemb, znzFile file)" --> size_t </td><td class="memItemRight" valign="bottom"><b>znzwrite</b> (const void *buf, size_t size, size_t nmemb, <a class="el" href="structznzptr.html">znzFile</a> file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e720f1e20e4a4849061ebf3a55d3d00"></a><!-- doxytag: member="znzlib.c::znzseek" ref="a8e720f1e20e4a4849061ebf3a55d3d00" args="(znzFile file, long offset, int whence)" --> long </td><td class="memItemRight" valign="bottom"><b>znzseek</b> (<a class="el" href="structznzptr.html">znzFile</a> file, long offset, int whence)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8100abd69a0c08858120a86c38dfbe6d"></a><!-- doxytag: member="znzlib.c::znzrewind" ref="a8100abd69a0c08858120a86c38dfbe6d" args="(znzFile stream)" --> int </td><td class="memItemRight" valign="bottom"><b>znzrewind</b> (<a class="el" href="structznzptr.html">znzFile</a> stream)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada3e90dbd58daddf0d99676129371557"></a><!-- doxytag: member="znzlib.c::znztell" ref="ada3e90dbd58daddf0d99676129371557" args="(znzFile file)" --> long </td><td class="memItemRight" valign="bottom"><b>znztell</b> (<a class="el" href="structznzptr.html">znzFile</a> file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a069bf95b347e0216af18a63c388e30ea"></a><!-- doxytag: member="znzlib.c::znzputs" ref="a069bf95b347e0216af18a63c388e30ea" args="(const char *str, znzFile file)" --> int </td><td class="memItemRight" valign="bottom"><b>znzputs</b> (const char *str, <a class="el" href="structznzptr.html">znzFile</a> file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c374a2fd16c2e73387c8fb6743fcc40"></a><!-- doxytag: member="znzlib.c::znzgets" ref="a9c374a2fd16c2e73387c8fb6743fcc40" args="(char *str, int size, znzFile file)" --> char * </td><td class="memItemRight" valign="bottom"><b>znzgets</b> (char *str, int size, <a class="el" href="structznzptr.html">znzFile</a> file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b5cf510220b990f0b5512639fc879b3"></a><!-- doxytag: member="znzlib.c::znzflush" ref="a3b5cf510220b990f0b5512639fc879b3" args="(znzFile file)" --> int </td><td class="memItemRight" valign="bottom"><b>znzflush</b> (<a class="el" href="structznzptr.html">znzFile</a> file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc453a2495be2545ba3b3840ac41a5db"></a><!-- doxytag: member="znzlib.c::znzeof" ref="abc453a2495be2545ba3b3840ac41a5db" args="(znzFile file)" --> int </td><td class="memItemRight" valign="bottom"><b>znzeof</b> (<a class="el" href="structznzptr.html">znzFile</a> file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a276a5a5f0319843fa920d2ba976841d6"></a><!-- doxytag: member="znzlib.c::znzputc" ref="a276a5a5f0319843fa920d2ba976841d6" args="(int c, znzFile file)" --> int </td><td class="memItemRight" valign="bottom"><b>znzputc</b> (int c, <a class="el" href="structznzptr.html">znzFile</a> file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec24a675883cee3f89f3bd82f7758821"></a><!-- doxytag: member="znzlib.c::znzgetc" ref="aec24a675883cee3f89f3bd82f7758821" args="(znzFile file)" --> int </td><td class="memItemRight" valign="bottom"><b>znzgetc</b> (<a class="el" href="structznzptr.html">znzFile</a> file)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af134c5a66b4d3370ff4c7e507834eea3"></a><!-- doxytag: member="znzlib.c::znzprintf" ref="af134c5a66b4d3370ff4c7e507834eea3" args="(znzFile stream, const char *format,...)" --> int </td><td class="memItemRight" valign="bottom"><b>znzprintf</b> (<a class="el" href="structznzptr.html">znzFile</a> stream, const char *format,...)</td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Low level i/o interface to compressed and noncompressed files. Written by Mark Jenkinson, FMRIB. </p> <p>This library provides an interface to both compressed (gzip/zlib) and uncompressed (normal) file IO. The functions are written to have the same interface as the standard file IO functions.</p> <p>To use this library instead of normal file IO, the following changes are required:</p> <ul> <li>replace all instances of FILE* with znzFile</li> <li>change the name of all function calls, replacing the initial character f with the znz (e.g. fseek becomes znzseek) one exception is rewind() -> znzrewind()</li> <li>add a third parameter to all calls to znzopen (previously fopen) that specifies whether to use compression (1) or not (0)</li> <li>use znz_isnull rather than any (pointer == NULL) comparisons in the code for znzfile types (normally done after a return from znzopen)</li> </ul> <p>NB: seeks for writable files with compression are quite restricted </p> </div></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Tue Jul 26 2011 for nifti1_io by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>