xp_trace_settextfilter (T-SQL)

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

Syntax

xp_trace_settextfilter {queue_handle, 'include_text', exclude_text'}

Arguments

queue_handle

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

'include_text'

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

'exclude_text'

Is a string value that represents the text exclude filter. The text exclude filter indicates the text, 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 text to exclude in the trace. If NULL, there is no excluded text for the specified event classes.

Note Generate the event class list by executing xp_trace_geteventnames.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_settextfilter returns this message:

The command(s) completed successfully.

Remarks

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

Permissions

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

Examples

This example configures the text filter value information for the trace queue. Events included are those with UPDATE in them.

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_settextfilter @queue_handle,

    'UPDATE%',

    NULL

See Also