EventInstance Класс

Ссылка

Определение

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

Сборка:: System.Diagnostics.EventLog.dll

Сборка:: System.dll

Пакет:: System.Diagnostics.EventLog v6.0.0

Пакет:: System.Diagnostics.EventLog v7.0.0

Пакет:: System.Diagnostics.EventLog v8.0.0

Пакет:: System.Diagnostics.EventLog v9.0.0-preview.2.24128.5

Исходный код:: EventData.cs

Исходный код:: EventData.cs

Исходный код:: 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 = 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

В примере кода используется следующий текстовый файл сообщения, встроенный в библиотеку ресурсов 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 помощью метода , необходимо зарегистрировать источник для журнала событий. Источник должен быть настроен для записи локализованных записей в журнал, а источник должен определить по крайней мере файл ресурсов сообщения.

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

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

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

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

Свойства

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

Методы

Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Применяется к

Бөлісу құралы: