home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _8737392c7e0c944da0cb78cb25fe5603 < prev    next >
Text File  |  2000-03-23  |  12KB  |  276 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Win32::EventLog - Process Win32 Event Logs from Perl</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::EventLog - Process Win32 Event Logs from Perl</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="#the eventlog object and its methods">The EventLog Object and its Methods</A></LI>
  26.     <LI><A HREF="#other win32::eventlog functions.">Other Win32::EventLog functions.</A></LI>
  27.     <LI><A HREF="#example 1">Example 1</A></LI>
  28.     <LI><A HREF="#example 2">Example 2</A></LI>
  29.     <LI><A HREF="#bugs">BUGS</A></LI>
  30.     <LI><A HREF="#author">AUTHOR</A></LI>
  31. </UL>
  32. <!-- INDEX END -->
  33.  
  34. <HR>
  35. <P>
  36. <H1><A NAME="name">NAME</A></H1>
  37. <P>Win32::EventLog - Process Win32 Event Logs from Perl</P>
  38. <P>
  39. <HR>
  40. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  41. <UL>
  42. <LI>Windows</LI>
  43. </UL>
  44. <HR>
  45. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  46. <PRE>
  47.         use Win32::EventLog
  48.         $handle=Win32::EventLog->new("Application");</PRE>
  49. <P>
  50. <HR>
  51. <H1><A NAME="description">DESCRIPTION</A></H1>
  52. <P>This module implements most of the functionality available from the
  53. Win32 API for accessing and manipulating Win32 Event Logs. The access
  54. to the EventLog routines is divided into those that relate to an
  55. EventLog object and its associated methods and those that relate other
  56. EventLog tasks (like adding an EventLog record).</P>
  57. <P>
  58. <HR>
  59. <H1><A NAME="the eventlog object and its methods">The EventLog Object and its Methods</A></H1>
  60. <P>The following methods are available to open, read, close and backup
  61. EventLogs.</P>
  62. <DL>
  63. <DT><STRONG><A NAME="item_new">Win32::EventLog->new(SOURCENAME [,SERVERNAME]);</A></STRONG><BR>
  64. <DD>
  65. The <A HREF="#item_new"><CODE>new()</CODE></A> method creates a new EventLog object and returns a handle
  66. to it. This hande is then used to call the methods below.
  67. <P>The method is overloaded in that if the supplied SOURCENAME
  68. argument contains one or more literal '\' characters (an illegal
  69. character in a SOURCENAME), it assumes that you are trying to open
  70. a backup eventlog and uses SOURCENAME as the backup eventlog to
  71. open. Note that when opening a backup eventlog, the SERVERNAME
  72. argument is ignored (as it is in the underlying Win32 API). For
  73. EventLogs on remote machines, the SOURCENAME parameter must
  74. therefore be specified as a UNC path.</P>
  75. <P></P>
  76. <DT><STRONG><A NAME="item_Backup">$handle->Backup(FILENAME);</A></STRONG><BR>
  77. <DD>
  78. The <A HREF="#item_Backup"><CODE>Backup()</CODE></A> method backs up the EventLog represented by $handle. It
  79. takes a single arguemt, FILENAME. When $handle represents an
  80. EventLog on a remote machine, FILENAME is filename on the remote
  81. machine and cannot be a UNC path (i.e you must use <EM>C:\TEMP\App.EVT</EM>).
  82. The method will fail if the log file already exists.
  83. <P></P>
  84. <DT><STRONG><A NAME="item_Read">$handle->Read(FLAGS, OFFSET, HASHREF);</A></STRONG><BR>
  85. <DD>
  86. The <A HREF="#item_Read"><CODE>Read()</CODE></A> method read an EventLog entry from the EventLog represented
  87. by $handle.
  88. <P></P>
  89. <DT><STRONG><A NAME="item_Close">$handle->Close();</A></STRONG><BR>
  90. <DD>
  91. The <A HREF="#item_Close"><CODE>Close()</CODE></A> method closes the EventLog represented by $handle. After
  92. <A HREF="#item_Close"><CODE>Close()</CODE></A> has been called, any further attempt to use the EventLog
  93. represented by $handle will fail.
  94. <P></P>
  95. <DT><STRONG><A NAME="item_GetOldest">$handle->GetOldest(SCALARREF);</A></STRONG><BR>
  96. <DD>
  97. The <A HREF="#item_GetOldest"><CODE>GetOldest()</CODE></A> method number of the the oldest EventLog record in
  98. the EventLog represented by $handle. This is required to correctly
  99. compute the OFFSET required by the <A HREF="#item_Read"><CODE>Read()</CODE></A> method.
  100. <P></P>
  101. <DT><STRONG><A NAME="item_GetNumber">$handle->GetNumber(SCALARREF);</A></STRONG><BR>
  102. <DD>
  103. The <A HREF="#item_GetNumber"><CODE>GetNumber()</CODE></A> method returns the number of EventLog records in
  104. the EventLog represented by $handle. The number of the most recent
  105. record in the EventLog is therefore computed by
  106. <PRE>
  107.         $handle->GetOldest($oldest);
  108.         $handle->GetNumber($lastRec);
  109.         $lastRecOffset=$oldest+$lastRec;</PRE>
  110. <P></P>
  111. <DT><STRONG><A NAME="item_Clear">$handle->Clear(FILENAME);</A></STRONG><BR>
  112. <DD>
  113. The <A HREF="#item_Clear"><CODE>Clear()</CODE></A> method clears the EventLog represented by $handle.  If
  114. you provide a non-null FILENAME, the EventLog will be backed up
  115. into FILENAME before the EventLog is cleared. The method will fail
  116. if FILENAME is specified and the file refered to exists. Note also
  117. that FILENAME specifies a file local to the machine on which the
  118. EventLog resides and cannot be specified as a UNC name.
  119. <P></P>
  120. <DT><STRONG><A NAME="item_Report">$handle->Report(HASHREF);</A></STRONG><BR>
  121. <DD>
  122. The <A HREF="#item_Report"><CODE>Report()</CODE></A> method generates an EventLog entry. The HASHREF should
  123. contain the following keys:
  124. <DL>
  125. <DT><STRONG><A NAME="item_Computer"><CODE>Computer</CODE></A></STRONG><BR>
  126. <DD>
  127. The <A HREF="#item_Computer"><CODE>Computer</CODE></A> field specfies which computer you want the EventLog
  128. entry recorded.  If this key doesn't exist, the server name used to
  129. create the $handle is used.
  130. <P></P>
  131. <DT><STRONG><A NAME="item_Source"><CODE>Source</CODE></A></STRONG><BR>
  132. <DD>
  133. The <A HREF="#item_Source"><CODE>Source</CODE></A> field specifies the source that generated the EventLog
  134. entry.  If this key doesn't exist, the source name used to create the
  135. $handle is used.
  136. <P></P>
  137. <DT><STRONG><A NAME="item_EventType"><CODE>EventType</CODE></A></STRONG><BR>
  138. <DD>
  139. The <A HREF="#item_EventType"><CODE>EventType</CODE></A> field should be one of the constants
  140. <DL>
  141. <DT><STRONG><A NAME="item_EVENTLOG_ERROR_TYPE"><CODE>EVENTLOG_ERROR_TYPE</CODE></A></STRONG><BR>
  142. <DD>
  143. An Error event is being logged.
  144. <P></P>
  145. <DT><STRONG><A NAME="item_EVENTLOG_WARNING_TYPE"><CODE>EVENTLOG_WARNING_TYPE</CODE></A></STRONG><BR>
  146. <DD>
  147. A Warning event is being logged.
  148. <P></P>
  149. <DT><STRONG><A NAME="item_EVENTLOG_INFORMATION_TYPE"><CODE>EVENTLOG_INFORMATION_TYPE</CODE></A></STRONG><BR>
  150. <DD>
  151. An Information event is being logged.
  152. <P></P>
  153. <DT><STRONG><A NAME="item_EVENTLOG_AUDIT_SUCCESS"><CODE>EVENTLOG_AUDIT_SUCCESS</CODE></A></STRONG><BR>
  154. <DD>
  155. A Success Audit event is being logged (typically in the Security
  156. EventLog).
  157. <P></P>
  158. <DT><STRONG><A NAME="item_EVENTLOG_AUDIT_FAILURE"><CODE>EVENTLOG_AUDIT_FAILURE</CODE></A></STRONG><BR>
  159. <DD>
  160. A Failure Audit event is being logged (typically in the Security
  161. EventLog).
  162. <P></P></DL>
  163. <P>These constants are exported into the main namespace by default.</P>
  164. <DT><STRONG><A NAME="item_Category"><CODE>Category</CODE></A></STRONG><BR>
  165. <DD>
  166. The <A HREF="#item_Category"><CODE>Category</CODE></A> field can have any value you want. It is specific to
  167. the particular Source.
  168. <P></P>
  169. <DT><STRONG><A NAME="item_EventID"><CODE>EventID</CODE></A></STRONG><BR>
  170. <DD>
  171. The <A HREF="#item_EventID"><CODE>EventID</CODE></A> field should contain the ID of the message that this
  172. event pertains too. This assumes that you have an associated message
  173. file (indirectly referenced by the field <A HREF="#item_Source"><CODE>Source</CODE></A>).
  174. <P></P>
  175. <DT><STRONG><A NAME="item_Data"><CODE>Data</CODE></A></STRONG><BR>
  176. <DD>
  177. The <A HREF="#item_Data"><CODE>Data</CODE></A> field contains raw data associated with this event.
  178. <P></P>
  179. <DT><STRONG><A NAME="item_Strings"><CODE>Strings</CODE></A></STRONG><BR>
  180. <DD>
  181. The <A HREF="#item_Strings"><CODE>Strings</CODE></A> field contains the single string that itself contains
  182. NUL terminated sub-strings. This are used with the EventID to generate
  183. the message as seen from (for example) the Event Viewer application.
  184. <P></P></DL>
  185. </DL>
  186. <P>
  187. <HR>
  188. <H1><A NAME="other win32::eventlog functions.">Other Win32::EventLog functions.</A></H1>
  189. <P>The following functions are part of the Win32::EventLog package but
  190. are not callable from an EventLog object.</P>
  191. <DL>
  192. <DT><STRONG><A NAME="item_GetMessageText">GetMessageText(HASHREF);</A></STRONG><BR>
  193. <DD>
  194. The <A HREF="#item_GetMessageText"><CODE>GetMessageText()</CODE></A> function assumes that HASHREF was obtained by
  195. a call to <A HREF="#item_Read"><CODE>$handle->Read()</CODE></A>. It returns the formatted string that
  196. represents the fully resolved text of the EventLog message (such as
  197. would be seen in the Windows NT Event Viewer). For convenience, the
  198. key 'Message' in the supplied HASHREF is also set to the return value
  199. of this function.
  200. <P>If you set the variable $Win32::EventLog::GetMessageText to 1 then
  201. each call to <A HREF="#item_Read"><CODE>$handle->Read()</CODE></A> will call this function automatically.</P>
  202. <P></P></DL>
  203. <P>
  204. <HR>
  205. <H1><A NAME="example 1">Example 1</A></H1>
  206. <P>The following example illustrates the way in which the EventLog module
  207. can be used. It opens the System EventLog and reads through it from
  208. oldest to newest records. For each record from the <STRONG>Source</STRONG> EventLog
  209. it extracts the full text of the Entry and prints the EventLog message
  210. text out.</P>
  211. <PRE>
  212.  use Win32::EventLog;</PRE>
  213. <PRE>
  214.  $handle=Win32::EventLog->new("System", $ENV{ComputerName})
  215.         or die "Can't open Application EventLog\n";
  216.  $handle->GetNumber($recs)
  217.         or die "Can't get number of EventLog records\n";
  218.  $handle->GetOldest($base)
  219.         or die "Can't get number of oldest EventLog record\n";</PRE>
  220. <PRE>
  221.  while ($x < $recs) {
  222.         $handle->Read(EVENTLOG_FORWARDS_READ|EVENTLOG_SEEK_READ,
  223.                                   $base+$x,
  224.                                   $hashRef)
  225.                 or die "Can't read EventLog entry #$x\n";
  226.         if ($hashRef->{Source} eq "EventLog") {
  227.                 Win32::EventLog::GetMessageText($hashRef);
  228.                 print "Entry $x: $hashRef->{Message}\n";
  229.         }
  230.         $x++;
  231.  }</PRE>
  232. <P>
  233. <HR>
  234. <H1><A NAME="example 2">Example 2</A></H1>
  235. <P>To backup and clear the EventLogs on a remote machine, do the following :-</P>
  236. <PRE>
  237.  use Win32::EventLog;</PRE>
  238. <PRE>
  239.  $myServer="\\\\my-server";     # your servername here.
  240.  my($date)=join("-", ((split(/\s+/, scalar(localtime)))[0,1,2,4]));
  241.  my($dest);</PRE>
  242. <PRE>
  243.  for my $eventLog ("Application", "System", "Security") {
  244.         $handle=Win32::EventLog->new($eventLog, $myServer)
  245.                 or die "Can't open Application EventLog on $myServer\n";</PRE>
  246. <PRE>
  247.         $dest="C:\\BackupEventLogs\\$eventLog\\$date.evt";
  248.         $handle->Backup($dest)
  249.                 or warn "Could not backup and clear the $eventLog EventLog on $myServer ($^E)\n";</PRE>
  250. <PRE>
  251.         $handle->Close;
  252.  }</PRE>
  253. <P>Note that only the Clear method is required. Note also that if the
  254. file $dest exists, the function will fail.</P>
  255. <P>
  256. <HR>
  257. <H1><A NAME="bugs">BUGS</A></H1>
  258. <P>None currently known.</P>
  259. <P>The test script for 'make test' should be re-written to use the
  260. EventLog object.</P>
  261. <P>
  262. <HR>
  263. <H1><A NAME="author">AUTHOR</A></H1>
  264. <P>Original code by Jesse Dougherty for HiP Communications. Additional
  265. fixes and updates attributed to Martin Pauley
  266. <<A HREF="mailto:martin.pauley@ulsterbank.ltd.uk">martin.pauley@ulsterbank.ltd.uk</A>>) and Bret Giddings (<A HREF="mailto:bret@essex.ac.uk">bret@essex.ac.uk</A>)</P>
  267. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  268. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  269. <STRONG><P CLASS=block> Win32::EventLog - Process Win32 Event Logs from Perl</P></STRONG>
  270. </TD></TR>
  271. </TABLE>
  272.  
  273. </BODY>
  274.  
  275. </HTML>
  276.