xp_trace_setobjidfilter (T-SQL)

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

Syntax

xp_trace_setobjidfilter {queue_handle, object_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.

object_ID

Is an integer that specifies the object ID for which to capture events. Object IDs can be obtained from the sysobjects system table.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_setobjidfilter returns this message:

The command(s) completed successfully.

Permissions

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

Examples

This example configures the object ID filter value for the trace queue. A value of 532 is used as the title ID for the titles table in the pubs database.

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

    532

See Also