EventInstance.CategoryId Vlastnost

Definice

Obor názvů:

System.Diagnostics

Sestavení:

System.Diagnostics.EventLog.dll

Zdroj:

EventData.cs

Získá nebo nastaví identifikátor prostředku, který určuje kategorii definovanou aplikací položky události.

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

Hodnota vlastnosti

Int32

Číselná hodnota kategorie nebo identifikátor prostředku, který odpovídá řetězci definovanému v souboru prostředků kategorie zdroje události. Výchozí hodnota je nula, což značí, že pro položku události se nezobrazí žádná kategorie.

Výjimky

ArgumentOutOfRangeException

Vlastnost je nastavena na zápornou hodnotu nebo na hodnotu větší než UInt16.MaxValue.

Příklady

Následující příklad kódu zapíše položku informační události a pak znovu použije EventInstance k zápisu položky pro událost upozornění do existujícího protokolu událostí událostí. Text zprávy události se zadává pomocí identifikátoru prostředku v souboru prostředku zprávy. Příklad kódu předpokládá, že odpovídající soubor prostředků zprávy byl registrován pro zdroj.

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

Příklad kódu používá následující textový soubor zprávy, integrovaný do knihovny prostředků EventLogMsgs.dll. Textový soubor zprávy je zdrojem, ze kterého se vytvoří soubor prostředku zprávy. Textový soubor zprávy definuje identifikátory prostředků a text pro řetězce vložení kategorie, zprávy události a parametru.

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

Poznámky

Kategorie protokolu událostí jsou hodnoty definované aplikací, které pomáhají filtrovat události, nebo poskytují další informace o události. Vaše aplikace může například definovat samostatné kategorie pro různé komponenty nebo různé operace.

CategoryId Nastavte vlastnost pro určení kategorie, kterou prohlížeč událostí zobrazí pro položku. Prohlížeč událostí může kategorii zobrazit jako číselnou hodnotu, nebo ji může použít CategoryId jako identifikátor prostředku k zobrazení lokalizovaného řetězce kategorie na základě aktuálního jazykového nastavení.

Chcete-li zobrazit lokalizované řetězce kategorií v Prohlížeči událostí, musíte použít zdroj událostí nakonfigurovaný se souborem prostředků kategorie a nastavit CategoryId identifikátor prostředku v souboru prostředků kategorie. Pokud zdroj události nemá nakonfigurovaný soubor prostředku kategorie nebo zadaný CategoryId řetězec v souboru prostředku kategorie indexuje a prohlížeč událostí zobrazí číselnou hodnotu kategorie pro danou položku.

Před zápisem kategorií událostí pomocí identifikátorů prostředků musíte zdroj zaregistrovat do odpovídajícího souboru prostředků. Nakonfigurujte soubor prostředku kategorie spolu s počtem řetězců kategorií v souboru prostředků pomocí EventLogInstaller třídy nebo EventSourceCreationData třídy. Při definování řetězců kategorií v souboru prostředků musí být identifikátory prostředků kategorie očíslovány po sobě jdoucí od 1 až do nakonfigurované CategoryCount hodnoty vlastnosti.

Kategorie událostí jsou volitelné. Pokud vaše aplikace nepoužívá kategorie, nenastavujte CategoryId položku protokolu událostí.

Podrobnosti o definování zpráv událostí a vytváření souborů prostředků událostí najdete v článku kompilátoru zpráv v dokumentaci k sadě SDK platformy. Podrobnosti o definování kategorií událostí v souborech prostředků najdete v tématu Kategorie událostí v sadě SDK platformy.

Viz také

• WriteEvent
• CategoryNumber
• CategoryResourceFile
• CategoryResourceFile