EventInstance.CategoryId プロパティ
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
イベント エントリのアプリケーション定義のカテゴリを指定するリソース識別子を取得または設定します。
public:
property int CategoryId { int get(); void set(int value); };public int CategoryId { get; set; }member this.CategoryId : int with get, setPublic Property CategoryId As Integerプロパティ値
イベント ソースのカテゴリ リソース ファイルで定義された文字列に対応するカテゴリ値またはリソース識別子。 既定値はゼロです。これは、イベント エントリに対してカテゴリが表示されないことを示します。
例外
プロパティは負の値または UInt16.MaxValue より大きい値に設定されます。
例
次のコード例では、情報イベント エントリを書き込み、 を再利用 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
.
注釈
イベント ログ カテゴリは、イベントをフィルター処理したり、イベントに関する詳細情報を提供したりするのに役立つアプリケーション定義の値です。 たとえば、アプリケーションでは、コンポーネントや操作ごとに個別のカテゴリを定義できます。
プロパティをCategoryId設定して、イベント ビューアーがエントリに表示するカテゴリを指定します。 イベント ビューアーは、カテゴリを数値として表示することも、リソース識別子として を使用CategoryIdして、現在の言語設定に基づいてローカライズされたカテゴリ文字列を表示することもできます。
イベント ビューアーにローカライズされたカテゴリ文字列を表示するには、カテゴリ リソース ファイルで構成されたイベント ソースを使用し、 をカテゴリ リソース ファイルのリソース識別子に設定CategoryIdする必要があります。 イベント ソースにカテゴリ リソース ファイルが構成されていない場合、または指定された CategoryId がカテゴリ リソース ファイル内の文字列にインデックスを付けなかった場合、イベント ビューアーはそのエントリの数値カテゴリ値を表示します。
リソース識別子を使用してイベント カテゴリを記述する前に、ソースを対応するリソース ファイルに登録する必要があります。 または クラスを使用して EventLogInstaller 、カテゴリ リソース ファイルとリソース ファイル内のカテゴリ文字列の数を EventSourceCreationData 構成します。 リソース ファイルでカテゴリ文字列を定義する場合、カテゴリ リソース識別子には、構成された CategoryCount プロパティ値まで、1 から順に番号を付ける必要があります。
イベント カテゴリは省略可能です。 アプリケーションでカテゴリを使用しない場合は、イベント ログ エントリの を CategoryId 設定しないでください。
イベント メッセージの定義とイベント リソース ファイルの構築の詳細については、Platform SDK ドキュメントの メッセージ コンパイラ に関する記事を参照してください。 リソース ファイルでのイベント カテゴリの定義の詳細については、Platform SDK の「イベント カテゴリ」トピックを参照してください。
適用対象
こちらもご覧ください
.NET