EventInstance Klasse

Definition

public ref class EventInstance

public class EventInstance

type EventInstance = class

Public Class EventInstance

Vererbung

Object

EventInstance

Beispiele

Im folgenden Codebeispiel wird ein Informationsereigniseintrag geschrieben, und anschließend wird der EventInstance Eintrag zum Schreiben eines Eintrags für ein Warnungsereignis in ein vorhandenes Ereignisprotokoll wiederverwendet. Der Ereignisnachrichtentext wird mithilfe eines Ressourcenbezeichners in einer Nachrichtenressourcendatei angegeben. Im Codebeispiel wird davon ausgegangen, dass die entsprechende Nachrichtenressourcendatei für die Quelle registriert wurde.

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

Im Codebeispiel wird die folgende Nachrichtentextdatei verwendet, die in die Ressourcenbibliothek EventLogMsgs.dllintegriert ist. Eine Nachrichtentextdatei ist die Quelle, aus der die Nachrichtenressourcendatei erstellt wird. Die Nachrichtentextdatei definiert die Ressourcenbezeichner und den Text für die Kategorie, Ereignisnachricht und Parametereinfügungszeichenfolgen.

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

Hinweise

Dient EventInstance zum Schreiben eines Ereignisprotokolleintrags mit einem Ressourcenbezeichner anstelle eines Zeichenfolgenwerts. Um einen Ereignisprotokolleintrag zu schreiben, initialisieren Sie die InstanceId Eigenschaft, und übergeben Sie die Instanz an die WriteEvent Methode. Die Ereignisanzeige verwendet den Instanzbezeichner, um die entsprechende Zeichenfolge aus der lokalisierten Ressourcendatei basierend auf den aktuellen Spracheinstellungen zu suchen und anzuzeigen. Sie müssen die Ereignisquelle bei der entsprechenden Ressourcendatei registrieren, bevor Sie Ereignisse mit Ressourcenbezeichnern schreiben.

Beim Schreiben von Ereignissen können Sie die EntryType Eigenschaft so festlegen, dass das Symbol angegeben wird, das die Ereignisanzeige für den Eintrag anzeigt. Sie können auch eine CategoryId Eigenschaft angeben, um die Kategorie anzugeben, die die Ereignisanzeige für den Eintrag anzeigt.

Die Ereignisanzeige verwendet die Kategorie zum Filtern von Ereignissen, die von einer Ereignisquelle geschrieben wurden. Die Ereignisanzeige kann die Kategorie als numerischer Wert anzeigen oder die Kategorie als Ressourcenbezeichner verwenden, um eine lokalisierte Kategoriezeichenfolge anzuzeigen.

Um lokalisierte Kategoriezeichenfolgen in der Ereignisanzeige anzuzeigen, müssen Sie eine Ereignisquelle verwenden, die mit einer Kategorieressourcendatei konfiguriert ist, und den CategoryId Wert in der Kategorieressourcendatei auf einen Ressourcenbezeichner festlegen. Wenn die Ereignisquelle keine konfigurierte Kategorieressourcendatei aufweist oder die angegebene CategoryId Datei keine Zeichenfolge in der Kategorieressourcendatei indiziert, zeigt die Ereignisanzeige den numerischen Kategoriewert für diesen Eintrag an. Konfigurieren Sie die Kategorieressourcendatei zusammen mit der Anzahl der Kategoriezeichenfolgen in der Ressourcendatei mithilfe EventLogInstaller der Klasse oder der EventSourceCreationData Klasse.

Sie müssen eine Quelle für ein Ereignisprotokoll registrieren, bevor EventInstance Sie ein Ereignis mit der WriteEvent Methode schreiben. Die Quelle muss für das Schreiben lokalisierter Einträge in das Protokoll konfiguriert werden, und die Quelle muss mindestens eine Nachrichtenressourcendatei definieren.

Erstellen Sie die neue Ereignisquelle während der Installation Ihrer Anwendung. Dadurch kann das Betriebssystem seine Liste der registrierten Ereignisquellen und deren Konfigurationen aktualisieren. Wenn das Betriebssystem seine Liste der Ereignisquellen nicht aktualisiert hat und Sie versuchen, ein Ereignis mit der neuen Quelle zu schreiben, schlägt der Schreibvorgang fehl. Sie können eine neue Quelle mithilfe einer EventLogInstallerOder mithilfe der CreateEventSource Methode konfigurieren. Sie müssen über Administratorrechte auf dem Computer verfügen, um eine neue Ereignisquelle zu erstellen.

Ausführliche Informationen zum Definieren von Ereignismeldungen und zum Erstellen von Ereignisprotokollressourcendateien finden Sie im Message Compiler-Artikel in der Platform SDK-Dokumentation.

Weitere Informationen

• WriteEvent
• EventLogEntry