EventProvider.WriteMessageEvent メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
データとして文字列を含むイベントを書き込みます。
オーバーロード
| 名前 | 説明 |
|---|---|
| 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
イベント データとして書き込む文字列。
返品
イベントが書き込まれる場合は true 。それ以外の場合は false。 false の場合は、 GetLastWriteEventError() メソッドを呼び出して、エラーの原因を特定します。
例外
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
イベント カテゴリを指定するビット マスク。 プロバイダーがマニフェストを使用してイベントを定義する場合は、この値をマニフェストで定義されているのと同じキーワード マスクに設定します。
返品
イベントが書き込まれる場合は true 。それ以外の場合は false。 false の場合は、 GetLastWriteEventError() メソッドを呼び出して、エラーの原因を特定します。
- 属性
例外
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 からイベント ヘッダーのサイズを引いた値に制限されます。 セッションのバッファー サイズが小さく、セッションにイベントを含む拡張データ項目が含まれている場合、イベント サイズは小さくなります。