classpfile.html

pwlib开发文档

<p>
Check for file existance. Determine if the file path specification associated with the instance of the object actually exists within the platforms file system.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the file exists. </dl>    </td>
  </tr>
</table>
<a name="z131_6" doxytag="PFile::Exists"></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"> BOOL PFile::Exists </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPFilePath.html">PFilePath</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>name</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Check for file existance.  Determine if the file specified actually exists within the platforms file system.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the file exists. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>&nbsp;</td><td>
Name of file to see if exists. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z133_1" doxytag="PFile::GetFilePath"></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"> PINLINE const <a class="el" href="classPFilePath.html">PFilePath</a> &amp; PFile::GetFilePath </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the full path name of the file. The PFilePath# object describes the full file name specification for the particular platform.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 the name of the file. </dl>    </td>
  </tr>
</table>
<a name="z133_10" doxytag="PFile::GetInfo"></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"> PINLINE BOOL PFile::GetInfo </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPFileInfo.html">PFileInfo</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>info</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get information (eg protection, timestamps) on the current file.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the file info was retrieved. </dl>    </td>
  </tr>
</table>
<a name="z133_12" doxytag="PFile::GetInfo"></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"> BOOL PFile::GetInfo </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPFilePath.html">PFilePath</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPFileInfo.html">PFileInfo</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>info</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get information (eg protection, timestamps) on the specified file.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the file info was retrieved. </dl>    </td>
  </tr>
</table>
<a name="z133_5" doxytag="PFile::GetLength"></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 off_t PFile::GetLength </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the current size of the file.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 length of file in bytes. </dl>
<p>
Reimplemented in <a class="el" href="classPMemoryFile.html#z489_0">PMemoryFile</a>.    </td>
  </tr>
</table>
<a name="z129_0" doxytag="PFile::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"> PINLINE <a class="el" href="classPString.html">PString</a> PFile::GetName </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the platform and I/O channel type name of the channel. For example, it would return the filename in <a class="el" href="classPFile.html#z125_2">PFile</a># type channels.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 the name of the channel. </dl>
<p>
Reimplemented from <a class="el" href="classPChannel.html#z47_1">PChannel</a>.    </td>
  </tr>
</table>
<a name="z133_8" doxytag="PFile::GetPosition"></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"> PINLINE off_t PFile::GetPosition </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the current active position in the file for the next read or write operation.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 current file position relative to start of file. </dl>
<p>
Reimplemented in <a class="el" href="classPMemoryFile.html#z489_3">PMemoryFile</a>, and <a class="el" href="classPWAVFile.html#z495_6">PWAVFile</a>.    </td>
  </tr>
</table>
<a name="z133_9" doxytag="PFile::IsEndOfFile"></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"> BOOL PFile::IsEndOfFile </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determine if the current file position is at the end of the file. If this is TRUE then any read operation will fail.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if at end of file. </dl>    </td>
  </tr>
</table>
<a name="z131_5" doxytag="PFile::Move"></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"> BOOL PFile::Move </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPFilePath.html">PFilePath</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>newname</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>force</em> = FALSE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Move the current file. This will move the file from one position in the directory hierarchy to another position. The actual operation is platform dependent but the reslt is the same. For instance, for Unix, if the move is within a file system then a simple rename is done, if it is across file systems then a copy and a delete is performed.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the file was moved. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>force</em>&nbsp;</td><td>
New path and name for the file. Delete file if a destination exists with the same name. </td></tr>
</table>
</dl>    </td>
  </tr>