Session.RemoveEvent(Event) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Management.XEvent

Assembly:: Microsoft.SqlServer.Management.XEvent.dll

Package:: Microsoft.SqlServer.SqlManagementObjects v150.18208.0

Package:: Microsoft.SqlServer.SqlManagementObjects v160.2004021.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Removes the event object from the session.

public bool RemoveEvent (Microsoft.SqlServer.Management.XEvent.Event evt);

member this.RemoveEvent : Microsoft.SqlServer.Management.XEvent.Event -> bool

Public Function RemoveEvent (evt As Event) As Boolean

Parameters

evt: Event

The event object.

Returns

Boolean

Returns whether the event is successfully removed.

Exceptions

ArgumentNullException

Parameter evt is null.

Applies to