EventInstance 构造函数

定义

使用非特定语言的信息初始化 EventInstance 类的一个新实例以定义事件日志项。Initializes a new instance of the EventInstance class using language-neutral information to define an event log entry.

重载

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.

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.

public:
 EventInstance(long instanceId, int categoryId);
public EventInstance (long instanceId, int categoryId);
new System.Diagnostics.EventInstance : int64 * int -> System.Diagnostics.EventInstance
Public Sub New (instanceId As Long, categoryId As Integer)

参数

instanceId
Int64

资源标识符,与事件源的消息资源文件中定义的字符串对应。A resource identifier that corresponds to a string defined in the message resource file of the event source.

categoryId
Int32

资源标识符,与事件源的类别资源文件中定义的字符串对应。如果没有为事件指定类别,则为零。A resource identifier that corresponds to a string defined in the category resource file of the event source, or zero to specify no category for the event.

例外

instanceId 参数是负值或大于 MaxValue 的值。The instanceId parameter is a negative value or a value larger than MaxValue.

- 或 --or- categoryId 参数是负值或大于 MaxValue 的值。The categoryId parameter is a negative value or a value larger than MaxValue.

示例

下面的代码示例编写一个信息性事件项,然后重新使用将 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 并将其传递给 WriteEvent 方法。To write an informational entry to an event log, initialize an EventInstance and pass it to the WriteEvent method. instanceId在源的相应属性中将设置为事件消息的资源标识符 MessageResourceFileSet the instanceId to the resource identifier of the event message in the corresponding MessageResourceFile property for the source. 将设置 categoryId 为数值类别值,或将源的属性中的事件类别的资源标识符设置为 CategoryResourceFile ; 对于 "无事件类别",将设置 categoryId 为零。Set the categoryId to a numeric category value, or the resource identifier of the event category in the CategoryResourceFile property for the source; set the categoryId to zero for no event category. EntryType默认情况下,新实例的属性设置为 InformationThe EntryType property for the new instance is set to Information by default.

事件查看器使用资源标识符显示源的本地化资源文件中的相应字符串。The Event Viewer uses the resource identifiers to display the corresponding strings from the localized resource files for the source. 必须先向相应的资源文件注册源,然后才能使用资源标识符编写事件。You must register the source with the corresponding resource files before you can write events using resource identifiers.

另请参阅

适用于

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.

public:
 EventInstance(long instanceId, int categoryId, System::Diagnostics::EventLogEntryType entryType);
public EventInstance (long instanceId, int categoryId, System.Diagnostics.EventLogEntryType entryType);
new System.Diagnostics.EventInstance : int64 * int * System.Diagnostics.EventLogEntryType -> System.Diagnostics.EventInstance
Public Sub New (instanceId As Long, categoryId As Integer, entryType As EventLogEntryType)

参数

instanceId
Int64

资源标识符,与事件源的消息资源文件中定义的字符串对应。A resource identifier that corresponds to a string defined in the message resource file of the event source.

categoryId
Int32

资源标识符,与事件源的类别资源文件中定义的字符串对应。如果没有为事件指定类别,则为零。A resource identifier that corresponds to a string defined in the category resource file of the event source, or zero to specify no category for the event.

entryType
EventLogEntryType

指示事件类型的 EventLogEntryType 值。An EventLogEntryType value that indicates the event type.

例外

entryType 不是有效的 EventLogEntryType 值。entryType is not a valid EventLogEntryType value.

instanceId 是负值或大于 MaxValue 的值。instanceId is a negative value or a value larger than MaxValue.

- 或 --or- categoryId 是负值或大于 MaxValue 的值。categoryId is a negative value or a value larger than MaxValue.

示例

下面的代码示例将两个审核事件项写入事件日志 myNewLogThe following code example writes two audit event entries to the event log myNewLog. 如果本地计算机上不存在新的事件源和新的事件日志,则代码示例将创建一个新的事件源和一个新的事件日志。The code example creates a new event source and a new event log if they do not exist on the local computer. 使用资源文件中的资源标识符指定事件消息文本。The event message text is specified using a resource identifier in a resource file.

// Create the event source if it does not exist.
String^ sourceName = "SampleApplicationSource";
if (  !EventLog::SourceExists( sourceName ) )
{
   
   // Call a local method to register the event log source
   // for the event log "myNewLog."  Use the resource file
   // EventLogMsgs.dll in the current directory for message text.
   String^ messageFile = String::Format( "{0}\\{1}", System::Environment::CurrentDirectory, "EventLogMsgs.dll" );
   CreateEventSourceSample1( messageFile );
}

// Get the event log corresponding to the existing source.
String^ myLogName = EventLog::LogNameFromSourceName( sourceName, "." );
EventLog^ myEventLog = gcnew EventLog( myLogName,".",sourceName );

// Define two audit events.
// The message identifiers correspond to the message text in the
// message resource file defined for the source.
EventInstance ^ myAuditSuccessEvent = gcnew EventInstance( AuditSuccessMsgId,0,EventLogEntryType::SuccessAudit );
EventInstance ^ myAuditFailEvent = gcnew EventInstance( AuditFailedMsgId,0,EventLogEntryType::FailureAudit );

// Insert the method name into the event log message.
array<String^>^insertStrings = {"EventLogSamples.WriteEventSample1"};

// Write the events to the event log.
myEventLog->WriteEvent( myAuditSuccessEvent, insertStrings );

// Append binary data to the audit failure event entry.
array<Byte>^binaryData = {3,4,5,6};
myEventLog->WriteEvent( myAuditFailEvent, binaryData, insertStrings );


// Create the event source if it does not exist.
string sourceName = "SampleApplicationSource";
if(!EventLog.SourceExists(sourceName))
{
    // Call a local method to register the event log source
    // for the event log "myNewLog."  Use the resource file
    // EventLogMsgs.dll in the current directory for message text.

    string messageFile =  String.Format("{0}\\{1}",
        System.Environment.CurrentDirectory,
        "EventLogMsgs.dll");

    CreateEventSourceSample1(messageFile);
}

// Get the event log corresponding to the existing source.
string myLogName = EventLog.LogNameFromSourceName(sourceName,".");

EventLog myEventLog = new EventLog(myLogName, ".", sourceName);

// Define two audit events.

// The message identifiers correspond to the message text in the
// message resource file defined for the source.
EventInstance myAuditSuccessEvent = new EventInstance(AuditSuccessMsgId, 0, EventLogEntryType.SuccessAudit);
EventInstance myAuditFailEvent = new EventInstance(AuditFailedMsgId, 0, EventLogEntryType.FailureAudit);

// Insert the method name into the event log message.
string [] insertStrings = {"EventLogSamples.WriteEventSample1"};

// Write the events to the event log.

myEventLog.WriteEvent(myAuditSuccessEvent, insertStrings);

// Append binary data to the audit failure event entry.
byte [] binaryData = { 3, 4, 5, 6 };
myEventLog.WriteEvent(myAuditFailEvent, binaryData, insertStrings);


           Dim sourceName As String = "SampleApplicationSource"

           ' Create the event source if it does not exist.
           If Not EventLog.SourceExists(sourceName)
  
               ' Call a local method to register the event log source
               ' for the event log "myNewLog."  Use the resource file
               ' EventLogMsgs.dll in the current directory for message text.

               Dim messageFile As String =  String.Format("{0}\\{1}", _
                   System.Environment.CurrentDirectory, _
                   "EventLogMsgs.dll")

               CreateEventSourceSample1(messageFile)
           End If 

           ' Get the event log corresponding to the existing source.
           Dim myLogName As String = EventLog.LogNameFromSourceName(sourceName,".")
       
           Dim myEventLog As EventLog = new EventLog(myLogName, ".", sourceName)

           ' Define two audit events.
           Dim myAuditSuccessEvent As EventInstance = new EventInstance(AuditSuccessMsgId, 0, EventLogEntryType.SuccessAudit)
           Dim myAuditFailEvent As EventInstance = new EventInstance(AuditFailedMsgId, 0, EventLogEntryType.FailureAudit)

           ' Insert the method name into the event log message.
           Dim insertStrings() As String = {"EventLogSamples.WriteEventSample1"}
           
           ' Write the events to the event log.

           myEventLog.WriteEvent(myAuditSuccessEvent, insertStrings)

           ' Append binary data to the audit failure event entry.
           Dim binaryData() As Byte = { 7, 8, 9, 10 }
           myEventLog.WriteEvent(myAuditFailEvent, binaryData, insertStrings)

此代码示例使用资源库中内置的以下消息文本文件 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 并将其传递给 WriteEvent 方法。To write an entry to an event log, initialize an EventInstance and pass it to the WriteEvent method. instanceId在源的相应属性中将设置为事件消息的资源标识符 MessageResourceFileSet the instanceId to the resource identifier of the event message in the corresponding MessageResourceFile property for the source. 将设置 categoryId 为数值类别值,或将源的属性中的事件类别的资源标识符设置为 CategoryResourceFile ; 对于 "无事件类别",将设置 categoryId 为零。Set the categoryId to a numeric category value, or the resource identifier of the event category in the CategoryResourceFile property for the source; set the categoryId to zero for no event category.

事件查看器使用资源标识符显示源的本地化资源文件中的相应字符串。The Event Viewer uses the resource identifiers to display the corresponding strings from the localized resource files for the source. 必须先向相应的资源文件注册源,然后才能使用资源标识符编写事件。You must register the source with the corresponding resource files before you can write events using resource identifiers.

将设置 entryType 为预定义的项类型之一。Set the entryType to one of the pre-defined entry types. 事件查看器使用事件类型确定要在事件日志的列表视图中显示哪个图标。The Event Viewer uses the event type to determine which icon to display in the list view of the event log.

另请参阅

适用于