home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _b8ddd69593d37f5cb2bd1ef9af23abe5 < prev    next >
Text File  |  2000-03-23  |  5KB  |  133 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>IO::Dir - supply object methods for directory handles</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> IO::Dir - supply object methods for directory handles</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  26.     <LI><A HREF="#author">AUTHOR</A></LI>
  27.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>IO::Dir - supply object methods for directory handles</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <PRE>
  46.     use IO::Dir;
  47.     $d = new IO::Dir ".";
  48.     if (defined $d) {
  49.         while (defined($_ = $d->read)) { something($_); }
  50.         $d->rewind;
  51.         while (defined($_ = $d->read)) { something_else($_); }
  52.         undef $d;
  53.     }</PRE>
  54. <PRE>
  55.     tie %dir, IO::Dir, ".";
  56.     foreach (keys %dir) {
  57.         print $_, " " , $dir{$_}->size,"\n";
  58.     }</PRE>
  59. <P>
  60. <HR>
  61. <H1><A NAME="description">DESCRIPTION</A></H1>
  62. <P>The <CODE>IO::Dir</CODE> package provides two interfaces to perl's directory reading
  63. routines.</P>
  64. <P>The first interface is an object approach. <CODE>IO::Dir</CODE> provides an object
  65. constructor and methods, which are just wrappers around perl's built in
  66. directory reading routines.</P>
  67. <DL>
  68. <DT><STRONG><A NAME="item_new">new ( [ DIRNAME ] )</A></STRONG><BR>
  69. <DD>
  70. <A HREF="#item_new"><CODE>new</CODE></A> is the constuctor for <CODE>IO::Dir</CODE> objects. It accepts one optional
  71. argument which,  if given, <A HREF="#item_new"><CODE>new</CODE></A> will pass to <A HREF="#item_open"><CODE>open</CODE></A>
  72. <P></P></DL>
  73. <P>The following methods are wrappers for the directory related functions built
  74. into perl (the trailing `dir' has been removed from the names). See <A HREF="../../lib/Pod/perlfunc.html">the perlfunc manpage</A>
  75. for details of these functions.</P>
  76. <DL>
  77. <DT><STRONG><A NAME="item_open">open ( DIRNAME )</A></STRONG><BR>
  78. <DD>
  79. <DT><STRONG><A NAME="item_read">read ()</A></STRONG><BR>
  80. <DD>
  81. <DT><STRONG><A NAME="item_seek">seek ( POS )</A></STRONG><BR>
  82. <DD>
  83. <DT><STRONG><A NAME="item_tell">tell ()</A></STRONG><BR>
  84. <DD>
  85. <DT><STRONG><A NAME="item_rewind">rewind ()</A></STRONG><BR>
  86. <DD>
  87. <DT><STRONG><A NAME="item_close">close ()</A></STRONG><BR>
  88. <DD>
  89. </DL>
  90. <P><CODE>IO::Dir</CODE> also provides a interface to reading directories via a tied
  91. HASH. The tied HASH extends the interface beyond just the directory
  92. reading routines by the use of <A HREF="../../lib/Pod/perlfunc.html#item_lstat"><CODE>lstat</CODE></A>, from the <CODE>File::stat</CODE> package,
  93. <A HREF="../../lib/Pod/perlfunc.html#item_unlink"><CODE>unlink</CODE></A>, <A HREF="../../lib/Pod/perlfunc.html#item_rmdir"><CODE>rmdir</CODE></A> and <A HREF="../../lib/Pod/perlfunc.html#item_utime"><CODE>utime</CODE></A>.</P>
  94. <DL>
  95. <DT><STRONG><A NAME="item_tie_%25hash%2C_IO%3A%3ADir%2C_DIRNAME_%5B%2C_OPTIO">tie %hash, IO::Dir, DIRNAME [, OPTIONS ]</A></STRONG><BR>
  96. <DD>
  97. </DL>
  98. <P>The keys of the HASH will be the names of the entries in the directory. 
  99. Reading a value from the hash will be the result of calling
  100. <CODE>File::stat::lstat</CODE>. Deleting an element from the hash will call <A HREF="../../lib/Pod/perlfunc.html#item_unlink"><CODE>unlink</CODE></A>
  101. providing that <CODE>DIR_UNLINK</CODE> is passed in the <CODE>OPTIONS</CODE>.</P>
  102. <P>Assigning to an entry in the HASH will cause the time stamps of the file
  103. to be modified. If the file does not exist then it will be created. Assigning
  104. a single integer to a HASH element will cause both the access and 
  105. modification times to be changed to that value. Alternatively a reference to
  106. an array of two values can be passed. The first array element will be used to
  107. set the access time and the second element will be used to set the modification
  108. time.</P>
  109. <P>
  110. <HR>
  111. <H1><A NAME="see also">SEE ALSO</A></H1>
  112. <P><A HREF="../../lib/File/stat.html">the File::stat manpage</A></P>
  113. <P>
  114. <HR>
  115. <H1><A NAME="author">AUTHOR</A></H1>
  116. <P>Graham Barr. Currently maintained by the Perl Porters.  Please report all
  117. bugs to <<A HREF="mailto:perl5-porters@perl.org">perl5-porters@perl.org</A>>.</P>
  118. <P>
  119. <HR>
  120. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  121. <P>Copyright (c) 1997-8 Graham Barr <<A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A>>. All rights reserved.
  122. This program is free software; you can redistribute it and/or
  123. modify it under the same terms as Perl itself.</P>
  124. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  125. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  126. <STRONG><P CLASS=block> IO::Dir - supply object methods for directory handles</P></STRONG>
  127. </TD></TR>
  128. </TABLE>
  129.  
  130. </BODY>
  131.  
  132. </HTML>
  133.