EventInstance Класс

Определение

Пространство имен:

System.Diagnostics

Сборка:

System.Diagnostics.EventLog.dll

Исходный код:

EventData.cs

Представляет сведения, нейтральные на языке, для записи журнала событий.

public ref class EventInstance

public class EventInstance

type EventInstance = class

Public Class EventInstance

Наследование

Object

EventInstance

Примеры

В следующем примере кода записывается информационная запись события, а затем повторно используется EventInstance запись для записи события предупреждения в существующий журнал событий. Текст сообщения о событии указывается с помощью идентификатора ресурса в файле ресурса сообщения. В примере кода предполагается, что соответствующий файл ресурса сообщения зарегистрирован для источника.

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

В примере кода используется следующий текстовый файл сообщения, встроенный в библиотеку ресурсов EventLogMsgs.dll. Текстовый файл сообщения — это источник, из которого создается файл ресурса сообщения. Текстовый файл сообщения определяет идентификаторы ресурсов и текст для категорий, сообщений о событии и строк вставки параметров.

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

Комментарии

Используется EventInstance для записи записи журнала событий с идентификатором ресурса, а не строковым значением. Чтобы записать запись журнала событий, инициализируйте InstanceId свойство и передайте экземпляр в WriteEvent метод. Средство просмотра событий использует идентификатор экземпляра для поиска и отображения соответствующей строки из локализованного файла ресурсов на основе текущих параметров языка. Перед записью событий с помощью идентификаторов ресурсов необходимо зарегистрировать источник событий в соответствующем файле ресурса.

При написании событий можно задать EntryType свойство, чтобы указать значок, который отображается в средстве просмотра событий для записи. Можно также указать свойство, чтобы указать CategoryId категорию, отображаемую средством просмотра событий для записи.

Средство просмотра событий использует категорию для фильтрации событий, написанных источником событий. Средство просмотра событий может отображать категорию в виде числового значения или использовать ее в качестве идентификатора ресурса для отображения локализованной строки категории.

Чтобы отобразить локализованные строки категорий в средстве просмотра событий, необходимо использовать источник событий, настроенный с помощью файла ресурса категории, и задать CategoryId идентификатор ресурса в файле ресурса категории. Если источник событий не содержит настроенный файл ресурса категории или указанный CategoryId не индексировать строку в файле ресурса категории, а средство просмотра событий отображает числовое значение категории для этой записи. Настройте файл ресурса категории, а также количество строк категорий в файле ресурса с помощью EventLogInstaller класса или EventSourceCreationData класса.

Перед записью EventInstance события с WriteEvent помощью метода необходимо зарегистрировать источник для журнала событий. Источник должен быть настроен для записи локализованных записей в журнал, а источник должен определить по крайней мере файл ресурса сообщения.

Создайте новый источник событий во время установки приложения. Это позволяет операционной системе обновлять список зарегистрированных источников событий и их конфигураций. Если операционная система не обновила свой список источников событий и попытается написать событие с новым источником, операция записи завершится ошибкой. Вы можете настроить новый источник с помощью EventLogInstallerметода или использовать CreateEventSource его. Для создания нового источника событий необходимо иметь права администратора на компьютере.

Дополнительные сведения об определении сообщений о событиях и создании файлов ресурсов журнала событий см. в статье компилятора сообщений в документации по пакету SDK для платформы.

Конструкторы

Имя	Описание
EventInstance(Int64, Int32, EventLogEntryType)	Инициализирует новый экземпляр EventInstance класса, используя указанные идентификаторы ресурсов для локализованного сообщения и текста категории записи события и указанного типа записи журнала событий.
EventInstance(Int64, Int32)	Инициализирует новый экземпляр EventInstance класса, используя указанные идентификаторы ресурсов для локализованного сообщения и текста категории записи события.

Свойства

Имя	Описание
CategoryId	Возвращает или задает идентификатор ресурса, указывающий определяемую приложением категорию записи события.
EntryType	Возвращает или задает тип события записи журнала событий.
InstanceId	Возвращает или задает идентификатор ресурса, указывающий текст сообщения записи события.

См. также раздел

• WriteEvent
• EventLogEntry