EventInstance.CategoryId Eigenschaft

Referenz

Definition

Namespace:: System.Diagnostics

Assembly:: System.Diagnostics.EventLog.dll

Assembly:: System.dll

Paket:: System.Diagnostics.EventLog v6.0.0

Paket:: System.Diagnostics.EventLog v7.0.0

Paket:: System.Diagnostics.EventLog v8.0.0

Paket:: System.Diagnostics.EventLog v9.0.0-preview.2.24128.5

Quelle:: EventData.cs

Quelle:: EventData.cs

Quelle:: EventData.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft den Ressourcenbezeichner ab, der die anwendungsdefinierte Kategorie des Ereigniseintrags angibt, oder legt diesen fest.

public:
 property int CategoryId { int get(); void set(int value); };

public int CategoryId { get; set; }

member this.CategoryId : int with get, set

Public Property CategoryId As Integer

Eigenschaftswert

Int32

Ein numerischer Kategoriewert oder Ressourcenbezeichner, der mit einer in der Kategorieressourcendatei der Ereignisquelle definierten Zeichenfolge übereinstimmt. Der Standardwert ist 0 (null) und bedeutet, dass für den Ereigniseintrag keine Kategorie angezeigt wird.

Ausnahmen

ArgumentOutOfRangeException

Die Eigenschaft wird auf einen negativen Wert oder auf einen Wert festgelegt, der größer als UInt16.MaxValue ist.

Beispiele

Im folgenden Codebeispiel wird ein Informationsereigniseintrag geschrieben und dann wiederverwendet, um einen Eintrag für ein Warnereignis in ein vorhandenes EventInstance Ereignisprotokoll zu schreiben. Der Ereignismeldungstext 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 = 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 );
}


// 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 Meldungstextdatei verwendet, die in die Ressourcenbibliothek EventLogMsgs.dll integriert ist. Eine Nachrichtentextdatei ist die Quelle, aus der die Nachrichtenressourcendatei erstellt wird. Die Nachrichtentextdatei definiert die Ressourcenbezeichner und den Text für die Kategorie, die Ereignismeldung und die 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

Ereignisprotokollkategorien sind anwendungsdefinierte Werte, mit denen Ereignisse gefiltert oder weitere Informationen zum Ereignis bereitgestellt werden können. Ihre Anwendung kann beispielsweise separate Kategorien für verschiedene Komponenten oder unterschiedliche Vorgänge definieren.

Legen Sie die CategoryId -Eigenschaft fest, um die Kategorie anzugeben, die vom Ereignisanzeige für den Eintrag angezeigt wird. Die Ereignisanzeige kann die Kategorie als numerischen Wert anzeigen oder als CategoryId Ressourcenbezeichner verwenden, um eine lokalisierte Kategoriezeichenfolge basierend auf den aktuellen Spracheinstellungen anzuzeigen.

Um lokalisierte Kategoriezeichenfolgen im Ereignisanzeige anzuzeigen, müssen Sie eine Ereignisquelle verwenden, die mit einer Kategorieressourcendatei konfiguriert ist, und legen Sie in CategoryId der Kategorieressourcendatei auf einen Ressourcenbezeichner fest. Wenn die Ereignisquelle keine konfigurierte Kategorieressourcendatei enthält oder die angegebene CategoryId keine Zeichenfolge in der Kategorieressourcendatei indiziert, zeigt die Ereignisanzeige den numerischen Kategoriewert für diesen Eintrag an.

Sie müssen die Quelle mit der entsprechenden Ressourcendatei registrieren, bevor Sie Ereigniskategorien mithilfe von Ressourcenbezeichnern schreiben. Konfigurieren Sie die Kategorieressourcendatei zusammen mit der Anzahl der Kategoriezeichenfolgen in der Ressourcendatei mithilfe der EventLogInstaller EventSourceCreationData -Klasse oder. Beim Definieren von Kategoriezeichenfolgen in einer Ressourcendatei müssen die Kategorieressourcenbezeichner nacheinander ab 1 nummeriert werden, bis zum konfigurierten CategoryCount Eigenschaftswert.

Ereigniskategorien sind optional. Wenn Ihre Anwendung keine Kategorien verwendet, legen Sie nicht für CategoryId den Ereignisprotokolleintrag fest.

Ausführliche Informationen zum Definieren von Ereignismeldungen und zum Erstellen von Ereignisressourcendateien finden Sie im Artikel Nachrichtencompiler in der Platform SDK-Dokumentation. Ausführliche Informationen zum Definieren von Ereigniskategorien in Ressourcendateien finden Sie im Thema "Ereigniskategorien" im Platform SDK.

Gilt für:

Share via