xp_trace_setwritefilter (T-SQL)

Specifies the write filter, or the minimum and maximum write operations to capture for the events specified. Microsoft® SQL Server™ captures the required information, configured by executing xp_trace_seteventclassrequired, for all events with a number of write operations greater than the minimum, if any, and less than the maximum, if any.

Syntax

xp_trace_setwritefilter {queue_handle, minimum_write,
    maximum_write}

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.

minimum_write

Is an integer specifying the minimum cumulative process writes for which to trace. There is no default value. If 0, there are no minimum restrictions. The maximum value is 4294967295.

maximum_write

Is an integer specifying the maximum cumulative process writes for which to trace. There is no default value. If 0, there are no maximum restrictions. The maximum value is 4294967295.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_setwritefilter returns this message:

The command(s) completed successfully.

Permissions

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

Examples

This example configures the write filter value information for trace queue. A minimum write value of 200 is specified and the maximum write operations value is 4750.

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

    200,

    4750

See Also