EventInstance Класс

Определение

Представляет не зависящие от языка сведения для записи журнала событий.Represents language-neutral information for an event log entry.

public ref class EventInstance
public class EventInstance
type EventInstance = class
Public Class EventInstance
Наследование
EventInstance

Примеры

В следующем примере кода записывается информационная запись события, а затем используется EventInstance для записи события предупреждения в существующий журнал событий.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. Текст сообщения о событии указывается с помощью идентификатора ресурса в файле ресурсов сообщения.The event message text is specified using a resource identifier in a message resource file. В примере кода предполагается, что для источника зарегистрирован соответствующий файл ресурсов сообщения.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

В примере кода используется следующий текстовый файл сообщения, встроенный в библиотеку ресурсов EventLogMsgs.dll.The code example uses the following message text file, built into the resource library EventLogMsgs.dll. Текстовый файл сообщения — это источник, из которого создается файл ресурсов сообщения.A message text file is the source from which the message resource file is created. В текстовом файле сообщения определяются идентификаторы ресурсов и текст для категории, сообщения о событии и строки вставки параметров.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  
.  

Комментарии

Используйте EventInstance для записи записи журнала событий с идентификатором ресурса, а не строковым значением.Use EventInstance to write an event log entry with a resource identifier rather than a string value. Чтобы записать запись в журнал событий, инициализируйте InstanceId свойство и передайте экземпляр в WriteEvent метод.To write an event log entry, initialize the InstanceId property and pass the instance to the WriteEvent method. Просмотр событий использует идентификатор экземпляра для поиска и вывода соответствующей строки из локализованного файла ресурсов на основе текущих языковых параметров.The Event Viewer uses the instance identifier to find and display the corresponding string from the localized resource file based on current language settings. Прежде чем записывать события с помощью идентификаторов ресурсов, необходимо зарегистрировать источник событий в соответствующем файле ресурсов.You must register the event source with the corresponding resource file before you write events using resource identifiers.

При записи событий можно задать EntryType свойство, чтобы указать значок, отображаемый Просмотр событий для записи.When writing events, you can set the EntryType property to specify the icon that the Event Viewer displays for the entry. Можно также указать CategoryId свойство, чтобы указать категорию, отображаемую Просмотр событий для записи.You can also specify a CategoryId property to specify the category that the Event Viewer displays for the entry.

Просмотр событий использует категорию для фильтрации событий, записанных источником событий.The Event Viewer uses the category to filter events written by an event source. Просмотр событий может отображать категорию в виде числового значения или использовать категорию в качестве идентификатора ресурса для вывода локализованной строки категории.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.

Чтобы отобразить локализованные строки категории в Просмотр событий, необходимо использовать источник событий, настроенный с помощью файла ресурсов категории, и задать CategoryId для него идентификатор ресурса в файле ресурсов категории.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. Если источник событий не имеет настроенного файла ресурсов категории или указанный объект не CategoryId индексирует строку в файле ресурсов категории, а затем Просмотр событий отображает числовое значение категории для этой записи.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. Настройте файл ресурсов категории вместе с числом строк категории в файле ресурсов, используя EventLogInstaller EventSourceCreationData класс или.Configure the category resource file, along with the number of category strings in the resource file, using the EventLogInstaller or the EventSourceCreationData class.

Необходимо зарегистрировать источник для журнала событий перед использованием EventInstance для записи события с помощью WriteEvent метода.You must register a source for an event log before using EventInstance to write an event with the WriteEvent method. Источник должен быть настроен для записи локализованных записей в журнал, и источник должен определить по крайней мере файл ресурсов сообщения.The source must be configured for writing localized entries to the log and the source must define at least a message resource file.

Создайте новый источник событий во время установки приложения.Create the new event source during the installation of your application. Это позволяет операционной системе обновлять список зарегистрированных источников событий и их конфигураций.This allows time for the operating system to refresh its list of registered event sources and their configurations. Если операционная система не обновила список источников событий и вы пытаетесь написать событие с новым источником, операция записи завершится ошибкой.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. Новый источник можно настроить с помощью EventLogInstaller или с помощью CreateEventSource метода.You can configure a new source using an EventLogInstaller, or using the CreateEventSource method. Для создания нового источника событий необходимо иметь права администратора на компьютере.You must have administrative rights on the computer to create a new event source.

Дополнительные сведения об определении сообщений о событиях и создании файлов ресурсов журнала событий см. в статье компилятор сообщений в документации по Platform SDK.For details about defining event messages and building event log resource files, see the Message Compiler article in the Platform SDK documentation.

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

EventInstance(Int64, Int32)

Инициализирует новый экземпляр класса EventInstance, используя заданные идентификаторы ресурсов для локализованного сообщения и текст категории для записи о событии.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)

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

Свойства

CategoryId

Получает или задает идентификатор ресурса, определяющий заданную приложением категорию записи о событии.Gets or sets the resource identifier that specifies the application-defined category of the event entry.

EntryType

Получает или задает тип события для записи в журнале событий.Gets or sets the event type of the event log entry.

InstanceId

Получает или задает идентификатор ресурса, определяющий текст сообщения для записи о событии.Gets or sets the resource identifier that designates the message text of the event entry.

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

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

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