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

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

イベントログエントリの言語に中立的な情報を表します。

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)

適用対象

次の方法で共有

EventInstance クラス

定義

例

注釈

コンストラクター

プロパティ

メソッド

適用対象

こちらもご覧ください

その他のリソース