xp_trace_geteventfilter (T-SQL)

Retrieves the current event class-specific text filter definition, which is configured by executing xp_trace_seteventfilter and associated with the specified trace queue.

Syntax

xp_trace_geteventfilter {queue_handle} [, event_class]

Arguments

queue_handle: Is an integer representing 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 representing the event class.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_geteventfilter returns this result set and returns a row for each required column.

Column name	Description
EventName	The event name number
IncludeEventFilter	The include text filter value for the specified event class
ExcludeEventFilter	The exclude text filter value for the specified event class

Permissions

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

Examples

A. Retrieve all event class-specific information

This example retrieves all event class-specific filter information, if event class information was set (by previously executing xp_trace_seteventfilter) for the specified trace queue (@queue_handle).

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_geteventfilter @queue_handle

B. Retrieve filter information for a specific event class

This example retrieves the event class filter information (set by executing xp_trace_seteventfilter) for event class 12 (SQL:BatchCompleted).