EventInstance.CategoryId プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

EventInstance.CategoryId プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

イベントエントリのアプリケーション定義のカテゴリを指定するリソース識別子を取得または設定します。

名前空間: System.Diagnostics
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Property CategoryId As
 Integer

Visual Basic (使用法)

Dim instance As EventInstance
Dim value As Integer

value = instance.CategoryId

instance.CategoryId = value

public int CategoryId { get;
 set; }

C++

public:
property int CategoryId {
    int get ();
    void set (int value);
}

/** @property */
public int get_CategoryId ()

/** @property */
public void set_CategoryId (int
 value)

JScript

public function get CategoryId
 () : int

public function set CategoryId
 (value : int)

プロパティ値
イベントソースのカテゴリリソースファイルで定義された文字列に対応するカテゴリ値またはリソース識別子。既定値はゼロです。これは、イベントエントリに対してカテゴリが表示されないことを示します。

例外

例外の種類	条件
ArgumentOutOfRangeException	プロパティが負の値または UInt16.MaxValue より大きい値に設定されています。

解説

イベントログカテゴリは、イベントをフィルタ処理したり、イベントに関する詳細情報を提供したりする、アプリケーション定義の値です。たとえば、アプリケーションはコンポーネントまたは操作ごとに個別のカテゴリを定義できます。

イベントビューアがエントリに対して表示するカテゴリを指定するには、CategoryId プロパティを設定します。イベントビューアには、カテゴリを数値として表示させたり、CategoryId をリソース識別子として使用して、現在の言語設定に基づいて、ローカライズされたカテゴリ文字列を表示させたりすることもできます。

ローカライズされたカテゴリ文字列をイベントビューアに表示するには、カテゴリリソースファイルで構成されたイベントソースを使用し、CategoryId を、カテゴリリソースファイル内のリソース識別子に設定する必要があります。イベントソースに構成済みのカテゴリリソースファイルがないか、指定された CategoryId がカテゴリリソースファイル内の文字列のインデックスを作成していない場合、イベントビューアは、そのエントリのカテゴリ値を表示します。

リソース識別子を使用してイベントカテゴリを書き込むには、対応するリソースファイルでソースを登録しておく必要があります。EventLogInstaller または EventSourceCreationData クラスを使用して、カテゴリリソースファイルを構成し、リソースファイル内のカテゴリ文字列数を設定します。リソースファイルのカテゴリ文字列を定義する場合、カテゴリリソース識別子には、1 から始まり、設定された CategoryCount プロパティ値までの番号を順番に付ける必要があります。

イベントカテゴリはオプションです。アプリケーションがカテゴリを使用しない場合は、イベントログエントリに CategoryId を設定しないでください。

イベントメッセージの定義およびイベントリソースファイルの作成の詳細については、http://www.microsoft.com/japan/msdn のプラットフォーム SDK ドキュメントで「Message Compiler」のトピックを参照してください。リソースファイルでイベントカテゴリを定義する方法については、プラットフォーム SDK の「イベントカテゴリ」のトピックを参照してください。

使用例

情報イベントエントリを書き込んだ後、EventInstance を再利用して、既存のイベントログに警告イベントのエントリを書き込むコード例を次に示します。イベントのメッセージテキストは、メッセージリソースファイルでリソース識別子を使用して指定されます。このコード例では、ソースに対して、対応するメッセージリソースファイルが登録されていることを前提にしています。

Visual Basic

' 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

// 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);
}

C++

// 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
 );
}

コード例では、リソースライブラリ 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
.

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
EventInstance クラス
EventInstance メンバ
System.Diagnostics 名前空間
System.Diagnostics.EventLog.WriteEvent
EventLogEntry.CategoryNumber
EventSourceCreationData.CategoryResourceFile
EventLogInstaller.CategoryResourceFile

>> 「EventInstance.CategoryId プロパティ」を含む用語の索引
EventInstance.CategoryId プロパティのページへのリンク

EventInstance.CategoryId プロパティとは？わかりやすく解説

EventInstance.CategoryId プロパティ

「EventInstance.CategoryId プロパティ」の関連用語


	© 2025 Microsoft.All rights reserved.

EventInstance.CategoryId プロパティとは？ わかりやすく解説

EventInstance.CategoryId プロパティ

急上昇のことば

「EventInstance.CategoryId プロパティ」の関連用語

EventInstance.CategoryId プロパティとは？わかりやすく解説