classpdirectory.html

pwlib开发文档

</table>
</dl>    </td>
  </tr>
</table>
<a name="z211_5" doxytag="PDirectory::IsSubDir"></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 BOOL PDirectory::IsSubDir </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>
Determine if the directory entry currently being scanned is itself another directory entry.
<p>
Note that the directory scan will {\bf not} return the "." and ".." entries that some platforms support.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if entry is a subdirectory. </dl>    </td>
  </tr>
</table>
<a name="z211_2" doxytag="PDirectory::Next"></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 PDirectory::Next </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>
Move to the next file in the directory scan.
<p>
Only files that are of a type that is specified in the mask passed to the <a class="el" href="classPDirectory.html#z211_0">Open()</a># or <a class="el" href="classPDirectory.html#z211_1">Restart()</a># functions will be returned.
<p>
Note that the directory scan will {\bf not} return the "." and ".." entries that some platforms support.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if there is another valid file in the directory. </dl>    </td>
  </tr>
</table>
<a name="z211_0" doxytag="PDirectory::Open"></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 BOOL PDirectory::Open </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>scanMask</em> = PFileInfo::AllFiles          </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>
Open the directory for scanning its list of files. Once opened the <a class="el" href="classPDirectory.html#z211_4">GetEntryName()</a># function may be used to get the current directory entry and the <a class="el" href="classPDirectory.html#z211_2">Next()</a># function used to move to the next directory entry.
<p>
Only files that are of a type that is specified in the mask will be returned.
<p>
Note that the directory scan will {\bf not} return the "." and ".." entries that some platforms support.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if directory was successfully opened, and there was at least one file in it of the specified types. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>scanMask</em>&nbsp;</td><td>
Mask of files to provide. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z205_4" doxytag="PDirectory::operator="></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 PDirectory &amp; PDirectory::operator= </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>cpathname</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>
Set the directory to the specified path. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>cstr</em>&nbsp;</td><td>
Directory path name for new object. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classPString.html#z231_22">PString</a>.    </td>
  </tr>
</table>
<a name="z205_3" doxytag="PDirectory::operator="></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 PDirectory &amp; PDirectory::operator= </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>pathname</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>
Set the directory to the specified path. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>str</em>&nbsp;</td><td>
Directory path name for new object. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classPString.html#z231_21">PString</a>.    </td>
  </tr>
</table>
<a name="z209_7" doxytag="PDirectory::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"> BOOL PDirectory::Remove </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>path</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>
Delete the specified directory.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if directory was deleted. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>path</em>&nbsp;</td><td>
Directory file path. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z209_3" doxytag="PDirectory::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"> PINLINE BOOL PDirectory::Remove </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>
Delete the directory.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if directory was deleted. </dl>    </td>
  </tr>
</table>
<a name="z211_1" doxytag="PDirectory::Restart"></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 BOOL PDirectory::Restart </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>scanMask</em> = PFileInfo::AllFiles          </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>
Restart file list scan from the beginning of directory. This is similar to the <a class="el" href="classPDirectory.html#z211_0">Open()</a># command but does not require that the directory be closed (using <a class="el" href="classPDirectory.html#z211_3">Close()</a>#) first.
<p>
Only files that are of a type that is specified in the mask will be returned.
<p>
Note that the directory scan will {\bf not} return the "." and ".." entries that some platforms support.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if directory was successfully opened, and there was at least one file in it of the specified types. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>scanMask</em>&nbsp;</td><td>
Mask of files to provide. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="n1" doxytag="PDirectory::directory"></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"> DIR* PDirectory::directory<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n3" doxytag="PDirectory::entryBuffer"></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"> struct dirent* PDirectory::entryBuffer<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n2" doxytag="PDirectory::entryInfo"></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"> <a class="el" href="classPFileInfo.html">PFileInfo</a>* PDirectory::entryInfo<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="n0" doxytag="PDirectory::scanMask"></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"> int PDirectory::scanMask<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Mask of file types that the directory scan will return.
<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="pdirect_8h-source.html">pdirect.h</a><li><a class="el" href="osutil_8inl.html">osutil.inl</a></ul>
<hr><address style="align: right;"><small>Generated on Wed Sep 29 22:44:15 2004 for PWLib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>