EventInstance Třída

Definice

Obor názvů:

System.Diagnostics

Sestavení:

System.Diagnostics.EventLog.dll

Zdroj:

EventData.cs

Představuje jazykově neutrální informace pro položku protokolu událostí.

public ref class EventInstance

public class EventInstance

type EventInstance = class

Public Class EventInstance

Dědičnost

Object

EventInstance

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

Slouží EventInstance k zápisu položky protokolu událostí s identifikátorem prostředku místo řetězcové hodnoty. Chcete-li napsat položku protokolu událostí, inicializovat InstanceId vlastnost a předat instanci metodě WriteEvent . Prohlížeč událostí používá identifikátor instance k vyhledání a zobrazení odpovídajícího řetězce z lokalizovaného souboru prostředků na základě aktuálního nastavení jazyka. Před zápisem událostí pomocí identifikátorů prostředků musíte zdroj událostí zaregistrovat do odpovídajícího souboru prostředků.

Při psaní událostí můžete vlastnost nastavit EntryType tak, aby určila ikonu, kterou prohlížeč událostí zobrazí pro danou položku. Můžete také zadat CategoryId vlastnost, která určuje kategorii, kterou prohlížeč událostí zobrazí pro položku.

Prohlížeč událostí používá kategorii k filtrování událostí napsaných zdrojem událostí. Prohlížeč událostí může kategorii zobrazit jako číselnou hodnotu nebo může kategorii použít jako identifikátor prostředku k zobrazení lokalizovaného řetězce kategorie.

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. 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řed použitím EventInstance k zápisu události s WriteEvent metodou je nutné zaregistrovat zdroj pro protokol událostí. Zdroj musí být nakonfigurován pro zápis lokalizovaných položek do protokolu a zdroj musí definovat alespoň soubor prostředku zprávy.

Během instalace aplikace vytvořte nový zdroj událostí. Díky tomu může operační systém aktualizovat seznam registrovaných zdrojů událostí a jejich konfigurací. Pokud operační systém neaktualizuje seznam zdrojů událostí a pokusíte se napsat událost s novým zdrojem, operace zápisu selže. Nový zdroj můžete nakonfigurovat pomocí metody EventLogInstallernebo metody CreateEventSource . Abyste mohli vytvořit nový zdroj událostí, musíte mít na počítači oprávnění správce.

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

Konstruktory

Name	Description
EventInstance(Int64, Int32, EventLogEntryType)	Inicializuje novou instanci EventInstance třídy pomocí zadaných identifikátorů prostředků pro lokalizovanou zprávu a text kategorie položky události a zadaný typ položky protokolu událostí.
EventInstance(Int64, Int32)	Inicializuje novou instanci EventInstance třídy pomocí zadaných identifikátorů prostředků pro lokalizovanou zprávu a text kategorie položky události.

Vlastnosti

Name	Description
CategoryId	Získá nebo nastaví identifikátor prostředku, který určuje kategorii definovanou aplikací položky události.
EntryType	Získá nebo nastaví typ události položky protokolu událostí.
InstanceId	Získá nebo nastaví identifikátor prostředku, který určuje text zprávy položky události.

Viz také

• WriteEvent
• EventLogEntry