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，減去事件標頭的大小。 如果工作階段的緩衝區大小較小且包含延伸的資料項目與事件，則事件大小較小。