This topic has not yet been rated - Rate this topic

EventInstance.InstanceId Property

Gets or sets the resource identifier that designates the message text of the event entry.

Namespace:  System.Diagnostics
Assembly:  System (in System.dll)
public long InstanceId { get; set; }

Property Value

Type: System.Int64
A resource identifier that corresponds to a string defined in the message resource file of the event source.
ExceptionCondition
ArgumentOutOfRangeException

The property is set to a negative value or to a value larger than UInt32.MaxValue.

The InstanceId property uniquely identifies an event entry for a configured event source. For events defined in message resource files, the InstanceId corresponds to the resource identifier compiled from the message definition fields in the message text file. Your application can write localized event log entries by setting the InstanceId to a resource identifier. The Event Viewer uses the InstanceId resource identifier to find and display the corresponding string from the localized resource file based on current language settings. You must register the source with the corresponding resource file before you write events using resource identifiers.

For details about defining event messages and building event log resource files, see the "Message Compiler" topic in the Platform SDK documentation at http://msdn.microsoft.com. For details about event log identifiers, see the "Event Identifiers" topic in the Platform SDK.

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 = new EventInstance(UpdateCycleCompleteMsgId, 0);

                // Write the event to the event log using the registered source.
                EventLog.WriteEvent(sourceName, myEvent);

                // 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.
                EventLog.WriteEvent(sourceName, myEvent, Environment.MachineName);
            }
            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
.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.