Session.RemoveEvent Method
Removes the specified Event object from the session.
Namespace: Microsoft.SqlServer.Management.XEvent
Assembly: Microsoft.SqlServer.Management.XEvent (in Microsoft.SqlServer.Management.XEvent.dll)
Syntax
'Declaration
Public Function RemoveEvent ( _
evt As Event _
) As Boolean
'Usage
Dim instance As Session
Dim evt As Event
Dim returnValue As Boolean
returnValue = instance.RemoveEvent(evt)
public bool RemoveEvent(
Event evt
)
public:
bool RemoveEvent(
Event^ evt
)
member RemoveEvent :
evt:Event -> bool
public function RemoveEvent(
evt : Event
) : boolean
Parameters
- evt
Type: Microsoft.SqlServer.Management.XEvent.Event
The Event object to remove.
Return Value
Type: System.Boolean
Returns True if the event is successfully removed, otherwise False.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | Parameter event is null. |