EventProvider.WriteMessageEvent 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
寫入一個包含字串作為資料的事件。
多載
| 名稱 | Description |
|---|---|
| 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
用字串來寫入事件資料。
傳回
若事件被寫為 ,則為 truefalse。 若錯誤,則呼叫該 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
事件中包含的細節程度。 如果提供者使用 manifest 來定義事件,則將此值設為清單中定義的相同層級。
- eventKeywords
- Int64
位元遮罩,指定事件類別。 如果提供者使用 manifest 來定義事件,則將此值設為與 manifest 中定義的相同關鍵字遮罩。
傳回
若事件被寫為 ,則為 truefalse。 若錯誤,則呼叫該 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,減去事件標頭大小。 若會話的緩衝區大小較小,且會話包含事件中的擴展資料項目,事件大小會較小。