xp_trace_setindidfilter (T-SQL)

Specifies the index identification number (INDID) filter, or the index ID to include for the events specified. Microsoft® SQL Server™ captures the required information, configured by executing xp_trace_seteventclassrequired, for the specified INDID.

Syntax

xp_trace_setindidfilter {queue_handle, index_ID}

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.

index_ID

Is an integer specifying the database index ID for which to capture events. Index IDs can be found in the sysindexes system table.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_setindidfilter returns this message:

The command(s) completed successfully.

Permissions

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

Examples

This example configures the index ID filter value for the trace queue and uses an index ID of 91, which is the index ID number for the index of a table.

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

    91

See Also