EventInstance Klasa

Definicja

Przedstawia informacje neutralne od języka dla wpisu dziennika zdarzeń.Represents language-neutral information for an event log entry.

public ref class EventInstance
public class EventInstance
type EventInstance = class
Public Class EventInstance
Dziedziczenie
EventInstance

Przykłady

Poniższy przykład kodu zapisuje wpis zdarzenia informacyjnego, a następnie ponownie używa programu EventInstance w celu zapisania wpisu dla zdarzenia ostrzegawczego w istniejącym dzienniku zdarzeń.The following code example writes an informational event entry, and then reuses the EventInstance to write an entry for a warning event to an existing event log. Tekst komunikatu o zdarzeniu jest określany przy użyciu identyfikatora zasobu w pliku zasobów wiadomości.The event message text is specified using a resource identifier in a message resource file. W przykładzie kodu założono, że odpowiedni plik zasobów wiadomości został zarejestrowany dla źródła.The code example assumes that the corresponding message resource file has been registered for the source.

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

W przykładzie kodu jest użyty następujący plik tekstowy komunikatu, wbudowany w bibliotekę zasobów EventLogMsgs.dll.The code example uses the following message text file, built into the resource library EventLogMsgs.dll. Plik tekstowy komunikatu jest źródłem, z którego tworzony jest plik zasobów wiadomości.A message text file is the source from which the message resource file is created. Plik tekstowy komunikatu określa identyfikatory zasobów i tekst dla kategorii, komunikat zdarzenia i ciągi wstawiania parametrów.The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings.

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

Uwagi

Użyj EventInstance , aby zapisać wpis dziennika zdarzeń z identyfikatorem zasobu, a nie wartością ciągu.Use EventInstance to write an event log entry with a resource identifier rather than a string value. Aby zapisać wpis dziennika zdarzeń, zainicjuj InstanceId Właściwość i przekaż wystąpienie do WriteEvent metody.To write an event log entry, initialize the InstanceId property and pass the instance to the WriteEvent method. Podgląd zdarzeń używa identyfikatora wystąpienia, aby znaleźć i wyświetlić odpowiedni ciąg z zlokalizowanego pliku zasobów na podstawie bieżących ustawień języka.The Event Viewer uses the instance identifier to find and display the corresponding string from the localized resource file based on current language settings. Przed zapisaniem zdarzeń przy użyciu identyfikatorów zasobów należy zarejestrować źródło zdarzeń z odpowiednim plikiem zasobów.You must register the event source with the corresponding resource file before you write events using resource identifiers.

Podczas pisania zdarzeń można ustawić EntryType Właściwość, aby określić ikonę, która Podgląd zdarzeń wyświetlana dla wpisu.When writing events, you can set the EntryType property to specify the icon that the Event Viewer displays for the entry. Możesz również określić CategoryId Właściwość, aby określić kategorię wyświetlaną dla wpisu w Podgląd zdarzeń.You can also specify a CategoryId property to specify the category that the Event Viewer displays for the entry.

Podgląd zdarzeń używa kategorii do filtrowania zdarzeń utworzonych przez Źródło zdarzenia.The Event Viewer uses the category to filter events written by an event source. Podgląd zdarzeń może wyświetlić kategorię jako wartość liczbową lub użyć kategorii jako identyfikatora zasobu, aby wyświetlić zlokalizowany ciąg kategorii.The Event Viewer can display the category as a numeric value, or it can use the category as a resource identifier to display a localized category string.

Aby wyświetlić zlokalizowane ciągi kategorii w Podgląd zdarzeń, należy użyć źródła zdarzenia skonfigurowanego z plikiem zasobów kategorii i ustawić wartość CategoryId na identyfikator zasobu w kategorii plik zasobów.To display localized category strings in the Event Viewer, you must use an event source configured with a category resource file, and set the CategoryId to a resource identifier in the category resource file. Jeśli źródło zdarzenia nie ma skonfigurowanego pliku zasobów kategorii lub określony CategoryId obiekt nie indeksuje ciąg w pliku zasobów kategorii, a następnie Podgląd zdarzeń wyświetla wartość liczbową kategorii dla tego wpisu.If the event source does not have a configured category resource file, or the specified CategoryId does not index a string in the category resource file, and then the Event Viewer displays the numeric category value for that entry. Skonfiguruj plik zasobów kategorii wraz z liczbą ciągów kategorii w pliku zasobu, używając EventLogInstaller lub EventSourceCreationData klasy.Configure the category resource file, along with the number of category strings in the resource file, using the EventLogInstaller or the EventSourceCreationData class.

Przed rozpoczęciem pisania zdarzenia za pomocą metody należy zarejestrować Źródło dziennika zdarzeń EventInstance WriteEvent .You must register a source for an event log before using EventInstance to write an event with the WriteEvent method. Źródło musi być skonfigurowane do zapisywania zlokalizowanych wpisów w dzienniku, a źródło musi definiować co najmniej plik zasobów komunikatów.The source must be configured for writing localized entries to the log and the source must define at least a message resource file.

Utwórz nowe źródło zdarzenia podczas instalacji aplikacji.Create the new event source during the installation of your application. Pozwala to czas na odświeżenie listy zarejestrowanych źródeł zdarzeń i ich konfiguracji przez system operacyjny.This allows time for the operating system to refresh its list of registered event sources and their configurations. Jeśli system operacyjny nie odświeżył swojej listy źródeł zdarzeń i podjęto próbę zapisania zdarzenia z nowym źródłem, operacja zapisu zakończy się niepowodzeniem.If the operating system has not refreshed its list of event sources, and you attempt to write an event with the new source, the write operation will fail. Nowe źródło można skonfigurować przy użyciu EventLogInstaller lub przy użyciu CreateEventSource metody.You can configure a new source using an EventLogInstaller, or using the CreateEventSource method. Aby utworzyć nowe źródło zdarzeń, musisz mieć uprawnienia administracyjne na komputerze.You must have administrative rights on the computer to create a new event source.

Aby uzyskać szczegółowe informacje na temat definiowania komunikatów o zdarzeniach i tworzenia plików zasobów dziennika zdarzeń, zobacz artykuł dotyczący kompilatora komunikatów w dokumentacji zestawu SDK platformy.For details about defining event messages and building event log resource files, see the Message Compiler article in the Platform SDK documentation.

Konstruktory

EventInstance(Int64, Int32)

Inicjuje nowe wystąpienie EventInstance klasy przy użyciu określonych identyfikatorów zasobów dla zlokalizowanego komunikatu i tekstu kategorii wpisu zdarzenia.Initializes a new instance of the EventInstance class using the specified resource identifiers for the localized message and category text of the event entry.

EventInstance(Int64, Int32, EventLogEntryType)

Inicjuje nowe wystąpienie EventInstance klasy przy użyciu określonych identyfikatorów zasobów dla zlokalizowanego komunikatu i tekstu kategorii wpisu zdarzenia i określonego typu wpisu dziennika zdarzeń.Initializes a new instance of the EventInstance class using the specified resource identifiers for the localized message and category text of the event entry and the specified event log entry type.

Właściwości

CategoryId

Pobiera lub ustawia identyfikator zasobu określający kategorię wpisu zdarzenia zdefiniowanego przez aplikację.Gets or sets the resource identifier that specifies the application-defined category of the event entry.

EntryType

Pobiera lub ustawia typ zdarzenia wpisu dziennika zdarzeń.Gets or sets the event type of the event log entry.

InstanceId

Pobiera lub ustawia identyfikator zasobu, który wyznacza tekst komunikatu wpisu zdarzenia.Gets or sets the resource identifier that designates the message text of the event entry.

Metody

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)

Dotyczy

Zobacz też