EventInstance Klass

Definition

public ref class EventInstance

public class EventInstance

type EventInstance = class

Public Class EventInstance

Arv

Object

EventInstance

Exempel

Följande kodexempel skriver en informationshändelsepost och återanvänder EventInstance sedan för att skriva en post för en varningshändelse till en befintlig händelselogg. Händelsemeddelandetexten anges med hjälp av en resursidentifierare i en meddelanderesursfil. Kodexemplet förutsätter att motsvarande meddelanderesursfil har registrerats för källan.

// 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);
}

' Ensure that the source has already been registered using
' EventLogInstaller or EventLog.CreateEventSource.
Dim sourceName as String = "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.
    Dim myEvent As EventInstance = 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)
End If

Kodexemplet använder följande meddelandetextfil som är inbyggd i resursbiblioteket EventLogMsgs.dll. En meddelandetextfil är källan från vilken meddelanderesursfilen skapas. Meddelandetextfilen definierar resursidentifierarna och texten för strängarna kategori, händelsemeddelande och parameterinfogning.

; // 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
.

Kommentarer

Använd EventInstance för att skriva en händelseloggpost med en resursidentifierare i stället för ett strängvärde. Om du vill skriva en händelseloggpost initierar du InstanceId egenskapen och skickar instansen WriteEvent till metoden. Zobrazovač udalostí använder instansidentifieraren för att hitta och visa motsvarande sträng från den lokaliserade resursfilen baserat på aktuella språkinställningar. Du måste registrera händelsekällan med motsvarande resursfil innan du skriver händelser med hjälp av resursidentifierare.

När du skriver händelser kan du ange egenskapen EntryType för att ange den ikon som Zobrazovač udalostí visar för posten. Du kan också ange egenskapen CategoryId för att ange den kategori som Zobrazovač udalostí visar för posten.

Zobrazovač udalostí använder kategorin för att filtrera händelser som skrivits av en händelsekälla. Zobrazovač udalostí kan visa kategorin som ett numeriskt värde eller använda kategorin som resursidentifierare för att visa en lokaliserad kategoristräng.

Om du vill visa lokaliserade kategoristrängar i Zobrazovač udalostí måste du använda en händelsekälla som konfigurerats med en kategoriresursfil och ange CategoryId till en resursidentifierare i kategoriresursfilen. Om händelsekällan inte har någon konfigurerad kategoriresursfil, eller om den angivna CategoryId inte indexera en sträng i kategoriresursfilen, och sedan visar Zobrazovač udalostí det numeriska kategorivärdet för den posten. Konfigurera kategoriresursfilen, tillsammans med antalet kategoristrängar i resursfilen, med hjälp av EventLogInstaller klassen eller EventSourceCreationData .

Du måste registrera en källa för en händelselogg innan du använder EventInstance för att skriva en händelse med WriteEvent metoden. Källan måste konfigureras för att skriva lokaliserade poster till loggen och källan måste definiera minst en meddelanderesursfil.

Skapa den nya händelsekällan under installationen av programmet. Detta gör det möjligt för operativsystemet att uppdatera sin lista över registrerade händelsekällor och deras konfigurationer. Om operativsystemet inte har uppdaterat sin lista över händelsekällor och du försöker skriva en händelse med den nya källan misslyckas skrivåtgärden. Du kan konfigurera en ny källa med hjälp av en EventLogInstaller, eller med hjälp av CreateEventSource metoden . Du måste ha administratörsbehörighet på datorn för att kunna skapa en ny händelsekälla.

Mer information om hur du definierar händelsemeddelanden och skapar resursfiler för händelseloggar finns i artikeln Meddelandekompilator i dokumentationen för Platform SDK.

Se även

• WriteEvent
• EventLogEntry