xp_trace_destroyqueue (T-SQL)

Destroys the given trace queue, but does not delete the queue definition. If the trace queue has a consumer, Microsoft® SQL Server™ waits to destroy the trace queue until the trace queue consumer has consumed all events in the trace queue.

Syntax

xp_trace_destroyqueue {queue_handle}

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.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_destroyqueue returns this message:

The command(s) completed successfully.

Permissions

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

Examples

This example destroys the trace queue named Seattle SELECTs.

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

See Also