EventProvider.WriteMessageEvent メソッド

定義

名前空間:

System.Diagnostics.Eventing

アセンブリ:

System.Core.dll

データとして文字列を保持するイベントを書き込みます。

オーバーロード

WriteMessageEvent(String)	データとして文字列を保持するイベントを書き込みます。
WriteMessageEvent(String, Byte, Int64)	レベルおよびキーワード値が、セッションによって要求されたイベントと一致する場合に、データとして文字列を保持するイベントを書き込みます。

注釈

これらのメソッドでは、イベントを使用するためにマニフェストは必要ありません。

WriteMessageEvent(String)

データとして文字列を保持するイベントを書き込みます。

public:
 bool WriteMessageEvent(System::String ^ eventMessage);

public bool WriteMessageEvent (string eventMessage);

member this.WriteMessageEvent : string -> bool

Public Function WriteMessageEvent (eventMessage As String) As Boolean

パラメーター

eventMessage

String

イベント データとして書き込む文字列。

戻り値

Boolean

イベントが書き込まれた場合は true。それ以外の場合は false。 false の場合は、GetLastWriteEventError() メソッドを呼び出すことで、失敗の原因を調べることができます。

例外

ArgumentException

eventMessage が null の場合。

例

if (!provider.WriteMessageEvent("Event string."))  
    Console.WriteLine(EventProvider.GetLastWriteEventError());  

注釈

文字列の最大長は、64 KB からイベント ヘッダーのサイズを差し引いた値に制限されます。 セッションのバッファー サイズが小さい場合や、イベントを含んだ拡張データ項目がセッションに存在する場合、イベント サイズはこれよりも小さくなります。

WriteMessageEvent(String, Byte, Int64)

レベルおよびキーワード値が、セッションによって要求されたイベントと一致する場合に、データとして文字列を保持するイベントを書き込みます。

public:
 bool WriteMessageEvent(System::String ^ eventMessage, System::Byte eventLevel, long eventKeywords);

[System.Security.SecurityCritical]
public bool WriteMessageEvent (string eventMessage, byte eventLevel, long eventKeywords);

[<System.Security.SecurityCritical>]
member this.WriteMessageEvent : string * byte * int64 -> bool

Public Function WriteMessageEvent (eventMessage As String, eventLevel As Byte, eventKeywords As Long) As Boolean

パラメーター

eventMessage

String

イベント データとして書き込む文字列。

eventLevel

Byte

イベントに含まれる詳細レベル。 プロバイダーがマニフェストを使ってイベントを定義する場合は、この値をマニフェストで定義されたものと同じレベルに設定します。

eventKeywords

Int64

イベントのカテゴリを指定するビット マスク。 プロバイダーがマニフェストを使ってイベントを定義する場合は、この値をマニフェストで定義されたものと同じキーワード マスクに設定します。

戻り値

Boolean

イベントが書き込まれた場合は true。それ以外の場合は false。 false の場合は、GetLastWriteEventError() メソッドを呼び出すことで、失敗の原因を調べることができます。

属性

SecurityCriticalAttribute

例外

ArgumentException

eventMessage が null の場合。

例

// Calling this method with level and keyword set to zero is the same  
// as calling WriteMessageEvent(string); the event is always written.  
if (!provider.WriteMessageEvent("Event string.", 0, 0))  
    Console.WriteLine(EventProvider.GetLastWriteEventError());  

// Event is written if the level value of the session is less than or equal to 3, and bit 1 of the session  
// keyword bit-mask is set.  
if (!provider.WriteMessageEvent("Event string.", 3, 2))  
    Console.WriteLine(EventProvider.GetLastWriteEventError());  

注釈

文字列の最大長は、64 KB からイベント ヘッダーのサイズを差し引いた値に制限されます。 セッションのバッファー サイズが小さい場合や、イベントを含んだ拡張データ項目がセッションに存在する場合、イベント サイズはこれよりも小さくなります。