aboutsummaryrefslogtreecommitdiff
path: root/doc/html/classIsis__File.html
blob: 25a5f472e08e85f037f6125c3a00d9b7b00257d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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>IsisReader: Isis_File Class 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.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.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)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Isis_File Class Reference</h1><!-- doxytag: class="Isis_File" -->
<p><a href="classIsis__File-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa1eab575168e86acbc4cca982096cb9"></a><!-- doxytag: member="Isis_File::Isis_File" ref="afa1eab575168e86acbc4cca982096cb9" args="($name, $write=0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Isis_File</b> ($name, $write=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97239ea7f444caa5435d4c466899d5fe"></a><!-- doxytag: member="Isis_File::mkxref" ref="a97239ea7f444caa5435d4c466899d5fe" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>mkxref</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__File.html#a7816de629f2445d8ef222850fefa886f">read</a> ($mfn)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__File.html#a77228e7d683ce9495c346cae8b5324a9">write</a> ($data, $mfn=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65597ebd86e5e157ce61853fef397af6"></a><!-- doxytag: member="Isis_File::compact" ref="a65597ebd86e5e157ce61853fef397af6" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>compact</b> ()</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87f4a4c34874d7e2cbaa9ff512c18183"></a><!-- doxytag: member="Isis_File::$name" ref="a87f4a4c34874d7e2cbaa9ff512c18183" args="" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>$name</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6bb6933cf34a895b7b08ea62fb718d2"></a><!-- doxytag: member="Isis_File::$mst" ref="aa6bb6933cf34a895b7b08ea62fb718d2" args="" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>$mst</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ac1676d578b76b551feb0641825ef7a"></a><!-- doxytag: member="Isis_File::$xrf" ref="a4ac1676d578b76b551feb0641825ef7a" args="" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>$xrf</b> = 0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f6a110cdb332072e80eeb1356182134"></a><!-- doxytag: member="Isis_File::$w" ref="a1f6a110cdb332072e80eeb1356182134" args="" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>$w</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsis__File.html#a790f9665ccf25048e4affe665e3930d6">$len</a> = 0</td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7816de629f2445d8ef222850fefa886f"></a><!-- doxytag: member="Isis_File::read" ref="a7816de629f2445d8ef222850fefa886f" args="($mfn)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Isis_File::read </td>
          <td>(</td>
          <td class="paramtype">$&nbsp;</td>
          <td class="paramname"> <em>mfn</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>string number $mfn or null </dd></dl>

</div>
</div>
<a class="anchor" id="a77228e7d683ce9495c346cae8b5324a9"></a><!-- doxytag: member="Isis_File::write" ref="a77228e7d683ce9495c346cae8b5324a9" args="($data, $mfn=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Isis_File::write </td>
          <td>(</td>
          <td class="paramtype">$&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&nbsp;</td>
          <td class="paramname"> <em>mfn</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>write $data as $mfn or ++$this-&gt;len </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>mfn </dd></dl>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a790f9665ccf25048e4affe665e3930d6"></a><!-- doxytag: member="Isis_File::$len" ref="a790f9665ccf25048e4affe665e3930d6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Isis_File::$len = 0</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>number of records == number of last record </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/openisis/php/Isis/File.php</li>
</ul>
</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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Mar 30 14:47:14 2010 for IsisReader by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>