xp_trace_setconnectionidfilter (T-SQL)

Specifies the connection ID filter, or the connection ID to include for the events specified. Microsoft® SQL Server™ captures the required information, configured by executing xp_trace_seteventclassrequired, for the included connection ID.

Syntax

xp_trace_setconnectionidfilter {queue_handle, connection_ID}

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.

connection_ID

Is an integer that specifies the connection ID. Connection IDs can be obtained by starting a trace in SQL Server Profiler and then identifying a unique connection ID to trace.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_setconnectionidfilter returns this message:

The command(s) completed successfully.

Permissions

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

Examples

This example configures the connection ID filter for a trace queue and uses a connection ID value of 1323.

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

    1323

See Also