mirror of
https://github.com/miky-kr5/NXT-Dev-Kits.git
synced 2023-01-29 18:47:06 +00:00
587 lines
25 KiB
HTML
Executable File
587 lines
25 KiB
HTML
Executable File
<html><body>
|
|
|
|
<!-- Generated by Doxygen 1.2.11.1 -->
|
|
<center>
|
|
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </center>
|
|
<hr><h1>nFANTOM100::iFile Class Reference</h1>Interface to a file on a LEGO MINDSTORMS NXT.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="iFile_8h-source.html">iFile.h</a>></code>
|
|
<p>
|
|
<a href="classnFANTOM100_1_1iFile-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a0">getName</a> (ViChar fileName[]) const=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Retrieves the name of this file.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual ViUInt32 </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a1">getSize</a> (<a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Retrieves the total size of this file in bytes.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual ViUInt32 </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a2">getAvailableSize</a> (<a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Retrieves the remaining available size, in bytes, in this file.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a3">openForRead</a> (<a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Opens this file for reading.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a4">openForWrite</a> (ViUInt32 sizeInBytes, <a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Open this file for writing.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a5">openForLinearWrite</a> (ViUInt32 sizeInBytes, <a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Open this file for linear (contiguous) writing.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a6">openForDataWrite</a> (ViUInt32 sizeInBytes, <a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Open this data file for writing.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a7">openForDataAppend</a> (<a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Open this data file for appending additional data.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a8">close</a> (<a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Closes this file.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual ViUInt32 </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a9">read</a> (ViPBuf bufferPtr, ViUInt32 numberOfBytes, <a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Reads from this file.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual ViUInt32 </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a10">write</a> (const ViByte bufferPtr[], ViUInt32 numberOfBytes, <a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Writes to this file.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#a11">remove</a> (<a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> &status)=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Removes this file.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="b0" doxytag="nFANTOM100::iFile::~iFile"></a>
|
|
virtual </td><td valign=bottom><a class="el" href="classnFANTOM100_1_1iFile.html#b0">~iFile</a> ()=0</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Destructor.</em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Friends</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="l0" doxytag="nFANTOM100::iFile::tNXT"></a>
|
|
class </td><td valign=bottom><b>tNXT</b></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Interface to a file on a LEGO MINDSTORMS NXT.
|
|
<p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a8" doxytag="nFANTOM100::iFile::close"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFile::close </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Closes this file.
|
|
<p>
|
|
Closes the file that corresponds to this object on the associated NXT. The file is not closed if the specified status is fatal.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a2" doxytag="nFANTOM100::iFile::getAvailableSize"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual ViUInt32 nFANTOM100::iFile::getAvailableSize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Retrieves the remaining available size, in bytes, in this file.
|
|
<p>
|
|
This number is only helpful for data logging files, which can contain variable amounts of data. The returned size is undefined if the specified status is fatal.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl><dl compact><dt><b>
|
|
Returns: </b><dd>
|
|
The remaining available size, in bytes, in this file. </dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a0" doxytag="nFANTOM100::iFile::getName"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFile::getName </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">ViChar </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>fileName</em>[] </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Retrieves the name of this file.
|
|
<p>
|
|
<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>fileName</em> </td><td>
|
|
Populated with the name of this file. The file name character array must be able to accomodate a NULL-terminated, 15.3 formatted module name. That is, it must have a capacity of 20 bytes. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a1" doxytag="nFANTOM100::iFile::getSize"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual ViUInt32 nFANTOM100::iFile::getSize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Retrieves the total size of this file in bytes.
|
|
<p>
|
|
The returned size is undefined if the specified status is fatal.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl><dl compact><dt><b>
|
|
Returns: </b><dd>
|
|
The total size of this file in bytes. </dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a7" doxytag="nFANTOM100::iFile::openForDataAppend"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFile::openForDataAppend </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Open this data file for appending additional data.
|
|
<p>
|
|
Opens, for appending additional data, the data file that corresponds to this object on the associated NXT. If this file doesn't exist on the NXT, the behavior is undefined. If this file does exist on the NXT, the data that is written is appended to the end of the exiting data. The file is not opened if the specified status is fatal.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a6" doxytag="nFANTOM100::iFile::openForDataWrite"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFile::openForDataWrite </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">ViUInt32 </td>
|
|
<td class="mdname" nowrap> <em>sizeInBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname" nowrap> <em>status</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Open this data file for writing.
|
|
<p>
|
|
Opens, for writing, the data file that corresponds to this object on the associated NXT. This data file differs from normal files in that a data file can be closed before the entire file has been written. If this file doesn't exist on the NXT, it is created. If this file does exist on the NXT, an error is generated. The file is not opened if the specified status is fatal.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>sizeInBytes</em> </td><td>
|
|
Size of the data, in bytes, that may be written to the file. </td></tr>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a5" doxytag="nFANTOM100::iFile::openForLinearWrite"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFile::openForLinearWrite </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">ViUInt32 </td>
|
|
<td class="mdname" nowrap> <em>sizeInBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname" nowrap> <em>status</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Open this file for linear (contiguous) writing.
|
|
<p>
|
|
Opens, for linear (contiguous) writing, the file that corresponds to this object on the associated NXT. If this file doesn't exist on the NXT, it is created. If this file does exist on the NXT, an error is generated. The file is not opened if the specified status is fatal.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>sizeInBytes</em> </td><td>
|
|
Size of the data, in bytes, that will be written to the file. </td></tr>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a3" doxytag="nFANTOM100::iFile::openForRead"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFile::openForRead </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Opens this file for reading.
|
|
<p>
|
|
Opens, for reading, the file that corresponds to this object on the associated NXT. The file is not opened if the specified status is fatal.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a4" doxytag="nFANTOM100::iFile::openForWrite"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFile::openForWrite </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">ViUInt32 </td>
|
|
<td class="mdname" nowrap> <em>sizeInBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname" nowrap> <em>status</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Open this file for writing.
|
|
<p>
|
|
Opens, for writing, the file that corresponds to this object on the associated NXT. If this file doesn't exist on the NXT, it is created. If this file does exist on the NXT, an error is generated. The file is not opened if the specified status is fatal.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>sizeInBytes</em> </td><td>
|
|
Size of the data, in bytes, that will be written to this file. </td></tr>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a9" doxytag="nFANTOM100::iFile::read"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual ViUInt32 nFANTOM100::iFile::read </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">ViPBuf </td>
|
|
<td class="mdname" nowrap> <em>bufferPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>ViUInt32 </td>
|
|
<td class="mdname" nowrap> <em>numberOfBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname" nowrap> <em>status</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Reads from this file.
|
|
<p>
|
|
Reads the specified number of bytes from this file into the specified buffer. No data is read if the specified status is fatal. The ownership of the buffer is not transferred to this file object.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>bufferPtr</em> </td><td>
|
|
A pointer to the buffer that will be populated with the data that is read. The capacity of the specified buffer must be at least the specified number of bytes. </td></tr>
|
|
<tr><td valign=top><em>numberOfBytes</em> </td><td>
|
|
Number of bytes to read. </td></tr>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl><dl compact><dt><b>
|
|
Returns: </b><dd>
|
|
The number of bytes actually read from this file.</dl><dl compact><dt><b>
|
|
Precondition: </b><dd>
|
|
This file must have been opened for reading with the <a class="el" href="classnFANTOM100_1_1iFile.html#a3">iFile::openForRead</a> method. </dl><dl compact><dt><b>
|
|
Postcondition: </b><dd>
|
|
The specified buffer may be deallocated. </dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a11" doxytag="nFANTOM100::iFile::remove"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual void nFANTOM100::iFile::remove </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>status</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Removes this file.
|
|
<p>
|
|
Removes the file that corresponds to this object on the associated NXT. The file is not removed if the specified status is fatal.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a10" doxytag="nFANTOM100::iFile::write"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> virtual ViUInt32 nFANTOM100::iFile::write </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const ViByte </td>
|
|
<td class="mdname" nowrap> <em>bufferPtr</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>ViUInt32 </td>
|
|
<td class="mdname" nowrap> <em>numberOfBytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap><a class="el" href="classnFANTOM100_1_1tStatus.html">tStatus</a> & </td>
|
|
<td class="mdname" nowrap> <em>status</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [pure virtual]</code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Writes to this file.
|
|
<p>
|
|
Writes the specified number of bytes from the specified buffer to this file. No data is written if the specified status is fatal. The ownership of the buffer is not transferred to this file object.<dl compact><dt><b>
|
|
Parameters: </b><dd>
|
|
<table border=0 cellspacing=2 cellpadding=0>
|
|
<tr><td valign=top><em>bufferPtr</em> </td><td>
|
|
A pointer to the buffer that contains the data that will be written. The capacity of the specified buffer must be at least the specified number of bytes. </td></tr>
|
|
<tr><td valign=top><em>numberOfBytes</em> </td><td>
|
|
Number of bytes to write to this file. </td></tr>
|
|
<tr><td valign=top><em>status</em> </td><td>
|
|
Status chaining object. </td></tr>
|
|
</table>
|
|
</dl><dl compact><dt><b>
|
|
Returns: </b><dd>
|
|
The number of bytes actually written to this file.</dl><dl compact><dt><b>
|
|
Precondition: </b><dd>
|
|
This file must have previously been opened for writing. </dl><dl compact><dt><b>
|
|
Postcondition: </b><dd>
|
|
The specified buffer may be deallocated. </dl> </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="iFile_8h-source.html">iFile.h</a></ul>
|
|
<p>
|
|
© Copyright 2005-2006, National Instruments Corporation. All rights reserved.
|
|
</p>
|
|
</body></html>
|
|
|