xp_trace_getqueueproperties (T-SQL)

Retrieves all current filters associated with the specified trace queue.

Syntax

xp_trace_getqueueproperties {queue_handle}

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.
Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_getqueueproperties returns this result set (each required column returns a row).

Column name Description
EventName Event number
IncludeEventFilter The include filter for the event
ExcludeEventFilter The exclude filter for the event

For each required column, xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
IncludeAppFilter Application include filter value for the trace queue
ExcludeAppFilter Application exclude filter value for the trace queue

For each required column, xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
IncludeHostFilter The include computer name filter value for the trace queue
ExcludeHostFilter The exclude computer name filter value for the trace queue

For each required column, xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
IncludeUserFilter The include username filter value for the trace queue
ExcludeUserFilter The exclude username filter value for the trace queue

For each required column, xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
IncludeNTNmFilter Microsoft® Windows NT® include computer name filter value for the trace queue
ExcludeNTNmFilter Microsoft Windows NT exclude computer name filter value for the trace queue

For each required column, xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
IncludeNTDmFilter Microsoft Windows NT include domain name filter value for the trace queue
ExcludeNTDmFilter Microsoft Windows NT exclude domain name filter value for the trace queue

For each required column, xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
IncludeTextFilter The include text filter value for the trace queue
ExcludeTextFilter The exclude text filter value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
IndexIDFilter Index ID filter value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
DatabaseIDFilter Database ID filter value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
ObjectIDFilter Object ID filter value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
ConnectionIDFilter Connection ID filter value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
HostProcessIDFilter Host process ID filter value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
SPIDFilter SPID filter value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
MinSeverity Minimum severity value for the trace queue
MaxSeverity Maximum severity value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
MinRead Minimum read value for the trace queue
MaxRead Maximum read value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
MinWrite Minimum write value for the trace queue
MaxWrite Maximum write value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
MinCPU Minimum CPU value for the trace queue
MaxCPU Maximum CPU value for the trace queue

xp_trace_getqueueproperties returns this result set.

Column name Description
EventQueue The trace queue number
MinDuration Minimum duration value for the trace queue
MaxDuration Maximum duration value for the trace queue

xp_trace_getqueueproperties returns this result set (one row for each event class).

Column name Description
EventClass Event class name
EventRequired Whether this event class is required (1) or not (0) for the trace queue

Permissions

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

Examples

This example retrieves all filter value information for the trace queue.

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_getqueueproperties @queue_handle

  

See Also
Monitoring with SQL Server Profiler System Stored Procedures (SQL Server Profiler Extended Procedures)
xp_trace_addnewqueue  

  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.