joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 09:46:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dash-docs/en/doxygen/html/classCAutoFile.html

828 lines
37 KiB
HTML
Raw Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: CAutoFile Class 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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classCAutoFile.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classCAutoFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CAutoFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="streams_8h_source.html">streams.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a52613083aaeab4c9238c649ae471783f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a52613083aaeab4c9238c649ae471783f">CAutoFile</a> (FILE *filenew, int nTypeIn, int nVersionIn)</td></tr>
<tr class="separator:a52613083aaeab4c9238c649ae471783f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1362f4cb52c819c25cff4598e0f28da"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#ab1362f4cb52c819c25cff4598e0f28da">~CAutoFile</a> ()</td></tr>
<tr class="separator:ab1362f4cb52c819c25cff4598e0f28da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcbafe943bfe392c09363078fa8a4e77"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#abcbafe943bfe392c09363078fa8a4e77">fclose</a> ()</td></tr>
<tr class="separator:abcbafe943bfe392c09363078fa8a4e77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25b51d94dc85c4140da0b15494ac9f8a"><td class="memItemLeft" align="right" valign="top">FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a25b51d94dc85c4140da0b15494ac9f8a">release</a> ()</td></tr>
<tr class="separator:a25b51d94dc85c4140da0b15494ac9f8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c1ad2d25562fea82a54bdef2793a0dd"><td class="memItemLeft" align="right" valign="top">FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a2c1ad2d25562fea82a54bdef2793a0dd">Get</a> () const</td></tr>
<tr class="separator:a2c1ad2d25562fea82a54bdef2793a0dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fd47268b6d85a89acafdb73559f8e78"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a7fd47268b6d85a89acafdb73559f8e78">IsNull</a> () const</td></tr>
<tr class="separator:a7fd47268b6d85a89acafdb73559f8e78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1a3986f191fe81384f58fc5fa073820"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#ac1a3986f191fe81384f58fc5fa073820">SetType</a> (int n)</td></tr>
<tr class="separator:ac1a3986f191fe81384f58fc5fa073820"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a774f2aad2c462d4ff47125ceec2ebab0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a774f2aad2c462d4ff47125ceec2ebab0">GetType</a> ()</td></tr>
<tr class="separator:a774f2aad2c462d4ff47125ceec2ebab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51f805bc470a95c9948250503b587aec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a51f805bc470a95c9948250503b587aec">SetVersion</a> (int n)</td></tr>
<tr class="separator:a51f805bc470a95c9948250503b587aec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a976ab8e5477aedd3a531fc49b01153ce"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a976ab8e5477aedd3a531fc49b01153ce">GetVersion</a> ()</td></tr>
<tr class="separator:a976ab8e5477aedd3a531fc49b01153ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9511060b5c971cff532faeab60c7d88b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a9511060b5c971cff532faeab60c7d88b">ReadVersion</a> ()</td></tr>
<tr class="separator:a9511060b5c971cff532faeab60c7d88b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23d6f22c3aff80be7665bfc5a77a01ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a23d6f22c3aff80be7665bfc5a77a01ff">WriteVersion</a> ()</td></tr>
<tr class="separator:a23d6f22c3aff80be7665bfc5a77a01ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87e670f3dd03055264c05b25335babb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCAutoFile.html">CAutoFile</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a87e670f3dd03055264c05b25335babb4">read</a> (char *pch, size_t nSize)</td></tr>
<tr class="separator:a87e670f3dd03055264c05b25335babb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b2852b345b75835f883be3732cf826a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCAutoFile.html">CAutoFile</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a7b2852b345b75835f883be3732cf826a">write</a> (const char *pch, size_t nSize)</td></tr>
<tr class="separator:a7b2852b345b75835f883be3732cf826a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a883a261f0d7d0320f72152ff2167fd24"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a883a261f0d7d0320f72152ff2167fd24"><td class="memTemplItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a883a261f0d7d0320f72152ff2167fd24">GetSerializeSize</a> (const T &amp;obj)</td></tr>
<tr class="separator:a883a261f0d7d0320f72152ff2167fd24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e194596d1f8f64059247724b25df82c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a8e194596d1f8f64059247724b25df82c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classCAutoFile.html">CAutoFile</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a8e194596d1f8f64059247724b25df82c">operator&lt;&lt;</a> (const T &amp;obj)</td></tr>
<tr class="separator:a8e194596d1f8f64059247724b25df82c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6826219322626d2ac8229e022c41dd7"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ae6826219322626d2ac8229e022c41dd7"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classCAutoFile.html">CAutoFile</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#ae6826219322626d2ac8229e022c41dd7">operator&gt;&gt;</a> (T &amp;obj)</td></tr>
<tr class="separator:ae6826219322626d2ac8229e022c41dd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a2d7c38154632735962c24d472c01608c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a2d7c38154632735962c24d472c01608c">CAutoFile</a> (const <a class="el" href="classCAutoFile.html">CAutoFile</a> &amp;)</td></tr>
<tr class="separator:a2d7c38154632735962c24d472c01608c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5937561da10e79c2da4bb47c0fc57d96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCAutoFile.html">CAutoFile</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a5937561da10e79c2da4bb47c0fc57d96">operator=</a> (const <a class="el" href="classCAutoFile.html">CAutoFile</a> &amp;)</td></tr>
<tr class="separator:a5937561da10e79c2da4bb47c0fc57d96"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a39ca705ff45e36a05acd5df3c4114aef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a39ca705ff45e36a05acd5df3c4114aef">nType</a></td></tr>
<tr class="separator:a39ca705ff45e36a05acd5df3c4114aef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23fb456ee23003aebc3c58ab3fd683c1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a23fb456ee23003aebc3c58ab3fd683c1">nVersion</a></td></tr>
<tr class="separator:a23fb456ee23003aebc3c58ab3fd683c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04ae666616ebc5d873c636fe6d2998ff"><td class="memItemLeft" align="right" valign="top">FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAutoFile.html#a04ae666616ebc5d873c636fe6d2998ff">file</a></td></tr>
<tr class="separator:a04ae666616ebc5d873c636fe6d2998ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Non-refcounted RAII wrapper for FILE*</p>
<p>Will automatically close the file when it goes out of scope if not null. If you're returning the file pointer, return file.release(). If you need to close the file early, use file.fclose() instead of fclose(file). </p>
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00346">346</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2d7c38154632735962c24d472c01608c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d7c38154632735962c24d472c01608c">&#9670;&nbsp;</a></span>CAutoFile() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CAutoFile::CAutoFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCAutoFile.html">CAutoFile</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a52613083aaeab4c9238c649ae471783f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52613083aaeab4c9238c649ae471783f">&#9670;&nbsp;</a></span>CAutoFile() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CAutoFile::CAutoFile </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>filenew</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nTypeIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nVersionIn</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00359">359</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="ab1362f4cb52c819c25cff4598e0f28da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1362f4cb52c819c25cff4598e0f28da">&#9670;&nbsp;</a></span>~CAutoFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CAutoFile::~CAutoFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00366">366</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abcbafe943bfe392c09363078fa8a4e77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abcbafe943bfe392c09363078fa8a4e77">&#9670;&nbsp;</a></span>fclose()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CAutoFile::fclose </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00371">371</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="streams_8h_source.html#l00366">~CAutoFile()</a>.</p>
</div>
</div>
<a id="a2c1ad2d25562fea82a54bdef2793a0dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c1ad2d25562fea82a54bdef2793a0dd">&#9670;&nbsp;</a></span>Get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FILE* CAutoFile::Get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get wrapped FILE* without transfer of ownership. </p><dl class="section note"><dt>Note</dt><dd>Ownership of the FILE* will remain with this class. Use this only if the scope of the <a class="el" href="classCAutoFile.html">CAutoFile</a> outlives use of the passed pointer. </dd></dl>
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00389">389</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a883a261f0d7d0320f72152ff2167fd24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a883a261f0d7d0320f72152ff2167fd24">&#9670;&nbsp;</a></span>GetSerializeSize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int CAutoFile::GetSerializeSize </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00424">424</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a774f2aad2c462d4ff47125ceec2ebab0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a774f2aad2c462d4ff47125ceec2ebab0">&#9670;&nbsp;</a></span>GetType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int CAutoFile::GetType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00399">399</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a976ab8e5477aedd3a531fc49b01153ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a976ab8e5477aedd3a531fc49b01153ce">&#9670;&nbsp;</a></span>GetVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int CAutoFile::GetVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00401">401</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a7fd47268b6d85a89acafdb73559f8e78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fd47268b6d85a89acafdb73559f8e78">&#9670;&nbsp;</a></span>IsNull()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool CAutoFile::IsNull </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if the wrapped FILE* is NULL, false otherwise. </p>
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00393">393</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="init_8cpp_source.html#l00942">AppInit2()</a>, <a class="el" href="init_8cpp_source.html#l00210">PrepareShutdown()</a>, and <a class="el" href="validation_8cpp_source.html#l01171">ReadBlockFromDisk()</a>.</p>
</div>
</div>
<a id="a8e194596d1f8f64059247724b25df82c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e194596d1f8f64059247724b25df82c">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCAutoFile.html">CAutoFile</a>&amp; CAutoFile::operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00431">431</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a5937561da10e79c2da4bb47c0fc57d96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5937561da10e79c2da4bb47c0fc57d96">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCAutoFile.html">CAutoFile</a>&amp; CAutoFile::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCAutoFile.html">CAutoFile</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae6826219322626d2ac8229e022c41dd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6826219322626d2ac8229e022c41dd7">&#9670;&nbsp;</a></span>operator&gt;&gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCAutoFile.html">CAutoFile</a>&amp; CAutoFile::operator&gt;&gt; </td>
<td>(</td>
<td class="paramtype">T &amp;&#160;</td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00441">441</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a87e670f3dd03055264c05b25335babb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87e670f3dd03055264c05b25335babb4">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCAutoFile.html">CAutoFile</a>&amp; CAutoFile::read </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>pch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>nSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00405">405</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a9511060b5c971cff532faeab60c7d88b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9511060b5c971cff532faeab60c7d88b">&#9670;&nbsp;</a></span>ReadVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CAutoFile::ReadVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00402">402</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a25b51d94dc85c4140da0b15494ac9f8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25b51d94dc85c4140da0b15494ac9f8a">&#9670;&nbsp;</a></span>release()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FILE* CAutoFile::release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get wrapped FILE* with transfer of ownership. </p><dl class="section note"><dt>Note</dt><dd>This will invalidate the <a class="el" href="classCAutoFile.html">CAutoFile</a> object, and makes it the responsibility of the caller of this function to clean up the returned FILE*. </dd></dl>
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00383">383</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="ac1a3986f191fe81384f58fc5fa073820"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1a3986f191fe81384f58fc5fa073820">&#9670;&nbsp;</a></span>SetType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CAutoFile::SetType </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00398">398</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a51f805bc470a95c9948250503b587aec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51f805bc470a95c9948250503b587aec">&#9670;&nbsp;</a></span>SetVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CAutoFile::SetVersion </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00400">400</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a7b2852b345b75835f883be3732cf826a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b2852b345b75835f883be3732cf826a">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCAutoFile.html">CAutoFile</a>&amp; CAutoFile::write </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>pch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>nSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00414">414</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<a id="a23d6f22c3aff80be7665bfc5a77a01ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23d6f22c3aff80be7665bfc5a77a01ff">&#9670;&nbsp;</a></span>WriteVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CAutoFile::WriteVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00403">403</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a04ae666616ebc5d873c636fe6d2998ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04ae666616ebc5d873c636fe6d2998ff">&#9670;&nbsp;</a></span>file</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FILE* CAutoFile::file</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00356">356</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="streams_8h_source.html#l00359">CAutoFile()</a>, <a class="el" href="streams_8h_source.html#l00371">fclose()</a>, <a class="el" href="streams_8h_source.html#l00389">Get()</a>, <a class="el" href="streams_8h_source.html#l00393">IsNull()</a>, <a class="el" href="streams_8h_source.html#l00431">operator&lt;&lt;()</a>, <a class="el" href="streams_8h_source.html#l00441">operator&gt;&gt;()</a>, <a class="el" href="streams_8h_source.html#l00405">read()</a>, <a class="el" href="streams_8h_source.html#l00383">release()</a>, and <a class="el" href="streams_8h_source.html#l00414">write()</a>.</p>
</div>
</div>
<a id="a39ca705ff45e36a05acd5df3c4114aef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39ca705ff45e36a05acd5df3c4114aef">&#9670;&nbsp;</a></span>nType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int CAutoFile::nType</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00353">353</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="streams_8h_source.html#l00359">CAutoFile()</a>, <a class="el" href="streams_8h_source.html#l00424">GetSerializeSize()</a>, <a class="el" href="streams_8h_source.html#l00399">GetType()</a>, <a class="el" href="streams_8h_source.html#l00431">operator&lt;&lt;()</a>, <a class="el" href="streams_8h_source.html#l00441">operator&gt;&gt;()</a>, and <a class="el" href="streams_8h_source.html#l00398">SetType()</a>.</p>
</div>
</div>
<a id="a23fb456ee23003aebc3c58ab3fd683c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23fb456ee23003aebc3c58ab3fd683c1">&#9670;&nbsp;</a></span>nVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int CAutoFile::nVersion</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="streams_8h_source.html#l00354">354</a> of file <a class="el" href="streams_8h_source.html">streams.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="streams_8h_source.html#l00359">CAutoFile()</a>, <a class="el" href="streams_8h_source.html#l00424">GetSerializeSize()</a>, <a class="el" href="streams_8h_source.html#l00401">GetVersion()</a>, <a class="el" href="streams_8h_source.html#l00431">operator&lt;&lt;()</a>, <a class="el" href="streams_8h_source.html#l00441">operator&gt;&gt;()</a>, <a class="el" href="streams_8h_source.html#l00402">ReadVersion()</a>, <a class="el" href="streams_8h_source.html#l00400">SetVersion()</a>, and <a class="el" href="streams_8h_source.html#l00403">WriteVersion()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="streams_8h_source.html">streams.h</a></li>
</ul>
</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="classCAutoFile.html">CAutoFile</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:11 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink