xp_trace_seteventfilter (T-SQL)

Specifies an event-specific text filter, or the text to include or exclude from the event specified. Microsoft® SQL Server™ captures the required information, configured by executing xp_trace_seteventclassrequired, for the included text for the specified event class and does not capture the required information for the excluded text, if any.

Syntax

xp_trace_seteventfilter {queue_handle, event_class, 'include_only_events',
    'exclude_events'}

Arguments

queue_handle

Is an integer that represents the handle for the trace queue. queue_handle is used to reference the trace queue and is placed in an output parameter by xp_trace_addnewqueue.

event_class

Is an integer value that represents the event class to filter. For more information about the possible values for event_class, see xp_trace_eventclassrequired.

'include_only_events'

Is a string value that represents the event include filter. The event include filter indicates the events, separated by semicolons (;), that should be considered when capturing data previously determined by xp_seteventclassrequired. The % wildcard character can be used in specifying the events to include in the trace. If NULL, there are no restrictions on events to include for the specified event classes.

'exclude_events'

Is a string value that represents the event exclude filter. The event exclude filter indicates the events, separated by semicolons (;), that should not be considered when capturing data previously determined by sp_seteventclassrequired. The % wildcard character can be used in specifying the events to exclude in the trace. If NULL, there are no excluded events for the specified event classes.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_seteventfilter returns this message:

The command(s) completed successfully.

Remarks

Generate the event class list by executing xp_trace_geteventnames.

When you specify one or more events to include, all other events are excluded.

Permissions

Execute permissions for xp_trace_seteventfilter default to members of the sysadmin fixed server role but can be granted to other users.

Examples

This example configures the event filter to retrieve all INSERT, UPDATE, and DELETE events in event class 13 (SQL:BatchStarting) for the trace queue.

USE master

DECLARE @queue_handle int, @column_value int

SET @column_value = 16|32|8192|128|512

EXEC xp_trace_addnewqueue 1000,

    5,

    95,

    90,

    @column_value,

    @queue_handle OUTPUT

EXEC xp_trace_seteventfilter @queue_handle,

    13,

    'INSERT%;DELETE%;UPDATE%',

    NULL

See Also