EventInstance::EntryType Property
Gets or sets the event type of the event log entry.
Assembly: System (in System.dll)
public: property EventLogEntryType EntryType { EventLogEntryType get(); void set(EventLogEntryType value); }
Property Value
Type: System.Diagnostics::EventLogEntryTypeAn EventLogEntryType value that indicates the event entry type. The default value is Information.
| Exception | Condition |
|---|---|
| InvalidEnumArgumentException | The property is not set to a valid EventLogEntryType value. |
Each event is of a single type, which the application indicates when it reports the event. The Event Viewer uses the event type to determine which icon to display in the list view of the event log.
The following code example writes an informational event entry, and then reuses the EventInstance to write an entry for a warning event to an existing event log. The event message text is specified using a resource identifier in a message resource file. The code example assumes that the corresponding message resource file has been registered for the source.
// Ensure that the source has already been registered using // EventLogInstaller or EventLog.CreateEventSource. String^ sourceName = "SampleApplicationSource"; if ( EventLog::SourceExists( sourceName ) ) { // Define an informational event with no category. // The message identifier corresponds to the message text in the // message resource file defined for the source. EventInstance ^ myEvent = gcnew EventInstance( UpdateCycleCompleteMsgId,0 ); // Write the event to the event log using the registered source. EventLog::WriteEvent( sourceName, myEvent, 0 ); // Reuse the event data instance for another event entry. // Set the entry category and message identifiers for // the appropriate resource identifiers in the resource files // for the registered source. Set the event type to Warning. myEvent->CategoryId = RefreshCategoryMsgId; myEvent->EntryType = EventLogEntryType::Warning; myEvent->InstanceId = ServerConnectionDownMsgId; // Write the event to the event log using the registered source. // Insert the machine name into the event message text. array<String^>^ss = {Environment::MachineName}; EventLog::WriteEvent( sourceName, myEvent, ss ); } else { Console::WriteLine( "Warning - event source {0} not registered", sourceName ); }
The code example uses the following message text file, built into the resource library EventLogMsgs.dll. A message text file is the source from which the message resource file is created. The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings.
; // EventLogMsgs.mc ; // ******************************************************** ; // Use the following commands to build this file: ; // mc -s EventLogMsgs.mc ; // rc EventLogMsgs.rc ; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res ; // ******************************************************** ; // - Event categories - ; // Categories must be numbered consecutively starting at 1. ; // ******************************************************** MessageId=0x1 Severity=Success SymbolicName=INSTALL_CATEGORY Language=English Installation . MessageId=0x2 Severity=Success SymbolicName=QUERY_CATEGORY Language=English Database Query . MessageId=0x3 Severity=Success SymbolicName=REFRESH_CATEGORY Language=English Data Refresh . ; // - Event messages - ; // ********************************* MessageId = 1000 Severity = Success Facility = Application SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000 Language=English My application message text, in English, for message id 1000, called from %1. . MessageId = 1001 Severity = Warning Facility = Application SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001 Language=English My application message text, in English, for message id 1001, called from %1. . MessageId = 1002 Severity = Success Facility = Application SymbolicName = GENERIC_INFO_MESSAGE_ID_1002 Language=English My generic information message in English, for message id 1002. . MessageId = 1003 Severity = Warning Facility = Application SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003 Language=English My generic warning message in English, for message id 1003, called from %1. . MessageId = 1004 Severity = Success Facility = Application SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004 Language=English The update cycle is complete for %%5002. . MessageId = 1005 Severity = Warning Facility = Application SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005 Language=English The refresh operation did not complete because the connection to server %1 could not be established. . ; // - Event log display name - ; // ******************************************************** MessageId = 5001 Severity = Success Facility = Application SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID Language=English Sample Event Log . ; // - Event message parameters - ; // Language independent insertion strings ; // ******************************************************** MessageId = 5002 Severity = Success Facility = Application SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID Language=English SVC_UPDATE.EXE .
Available since 2.0