home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _b3dafc76360a8f9a556635db1cedd6ff < prev    next >
Text File  |  2000-03-23  |  5KB  |  133 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Win32::ChangeNotify - Monitor events related to files and directories</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> Win32::ChangeNotify - Monitor events related to files and directories</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.     <UL>
  26.  
  27.         <LI><A HREF="#methods">Methods</A></LI>
  28.         <LI><A HREF="#deprecated functions and methods">Deprecated Functions and Methods</A></LI>
  29.     </UL>
  30.  
  31.     <LI><A HREF="#author">AUTHOR</A></LI>
  32. </UL>
  33. <!-- INDEX END -->
  34.  
  35. <HR>
  36. <P>
  37. <H1><A NAME="name">NAME</A></H1>
  38. <P>Win32::ChangeNotify - Monitor events related to files and directories</P>
  39. <P>
  40. <HR>
  41. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  42. <UL>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <PRE>
  48.         require Win32::ChangeNotify;</PRE>
  49. <PRE>
  50.         $notify = Win32::ChangeNotify->new($Path,$WatchSubTree,$Events);
  51.         $notify->wait or warn "Something failed: $!\n";
  52.         # There has been a change.</PRE>
  53. <P>
  54. <HR>
  55. <H1><A NAME="description">DESCRIPTION</A></H1>
  56. <P>This module allows the user to use a Win32 change notification event
  57. object from Perl.  This allows the Perl program to monitor events
  58. relating to files and directory trees.</P>
  59. <P>The <A HREF="#item_wait"><CODE>wait</CODE></A> method and <CODE>wait_all</CODE> & <CODE>wait_any</CODE> functions are
  60. inherited from the <A HREF="#win32::ipc">Win32::IPC</A> module.</P>
  61. <P>
  62. <H2><A NAME="methods">Methods</A></H2>
  63. <DL>
  64. <DT><STRONG><A NAME="item_new">$notify = Win32::ChangeNotify->new($path, $subtree, $filter)</A></STRONG><BR>
  65. <DD>
  66. Constructor for a new ChangeNotification object.  <CODE>$path</CODE> is the
  67. directory to monitor.  If <CODE>$subtree</CODE> is true, then all directories
  68. under <CODE>$path</CODE> will be monitored.  <CODE>$filter</CODE> indicates what events
  69. should trigger a notification.  It should be a string containing any
  70. of the following flags (separated by whitespace and/or <CODE>|</CODE>).
  71. <PRE>
  72.    ATTRIBUTES   Any attribute change
  73.    DIR_NAME     Any directory name change
  74.    FILE_NAME    Any file name change (creating/deleting/renaming)
  75.    LAST_WRITE   Any change to a file's last write time
  76.    SECURITY     Any security descriptor change
  77.    SIZE         Any change in a file's size</PRE>
  78. <P>(<CODE>$filter</CODE> can also be an integer composed from the
  79. <CODE>FILE_NOTIFY_CHANGE_*</CODE> constants.)</P>
  80. <P></P>
  81. <DT><STRONG><A NAME="item_close">$notify->close</A></STRONG><BR>
  82. <DD>
  83. Shut down monitoring.  You could just <CODE>undef $notify</CODE> instead (but
  84. <A HREF="#item_close"><CODE>close</CODE></A> works even if there are other copies of the object).  This
  85. happens automatically when your program exits.
  86. <P></P>
  87. <DT><STRONG><A NAME="item_reset">$notify->reset</A></STRONG><BR>
  88. <DD>
  89. Resets the ChangeNotification object after a change has been detected.
  90. The object will become signalled again after the next change.  (It is
  91. OK to call this immediately after <A HREF="#item_new"><CODE>new</CODE></A>, but it is not required.)
  92. <P></P>
  93. <DT><STRONG><A NAME="item_wait">$notify->wait</A></STRONG><BR>
  94. <DD>
  95. See <A HREF="#win32::ipc">Win32::IPC</A>.  Remember to call <A HREF="#item_reset"><CODE>reset</CODE></A> afterwards if you want
  96. to continue monitoring.
  97. <P></P></DL>
  98. <P>
  99. <H2><A NAME="deprecated functions and methods">Deprecated Functions and Methods</A></H2>
  100. <P><STRONG>Win32::ChangeNotify</STRONG> still supports the ActiveWare syntax, but its
  101. use is deprecated.</P>
  102. <DL>
  103. <DT><STRONG><A NAME="item_FindFirst"><CODE>FindFirst($Obj,$PathName,$WatchSubTree,$Filter)</CODE></A></STRONG><BR>
  104. <DD>
  105. Use
  106. <PRE>
  107.   $Obj = Win32::ChangeNotify->new($PathName,$WatchSubTree,$Filter)</PRE>
  108. <P>instead.</P>
  109. <P></P>
  110. <DT><STRONG><A NAME="item_FindNext">$obj-><CODE>FindNext()</CODE></A></STRONG><BR>
  111. <DD>
  112. Use <A HREF="#item_reset"><CODE>$obj->reset</CODE></A> instead.
  113. <P></P>
  114. <DT><STRONG><A NAME="item_Close">$obj-><CODE>Close()</CODE></A></STRONG><BR>
  115. <DD>
  116. Use <A HREF="#item_close"><CODE>$obj->close</CODE></A> instead.
  117. <P></P></DL>
  118. <P>
  119. <HR>
  120. <H1><A NAME="author">AUTHOR</A></H1>
  121. <P>Christopher J. Madsen <<EM><A HREF="mailto:chris_madsen@geocities.com">chris_madsen@geocities.com</A></EM>></P>
  122. <P>Loosely based on the original module by ActiveWare Internet Corp.,
  123. <EM><A HREF="http://www.ActiveWare.com">http://www.ActiveWare.com</A></EM></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> Win32::ChangeNotify - Monitor events related to files and directories</P></STRONG>
  127. </TD></TR>
  128. </TABLE>
  129.  
  130. </BODY>
  131.  
  132. </HTML>
  133.