xp_trace_pausequeue (T-SQL)

Suspends new events from being added to the trace queue.

Syntax

xp_trace_pausequeue {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_loadpausequeue returns this message:

The command(s) completed successfully.

Remarks

xp_trace_pausequeue does not impose a time limit before allowing the addition of new events to the trace queue. Use xp_trace_restartqueue to restart a paused trace queue.

Pause a trace queue to:

• Check the status of an existing trace.
• Monitor the output of an existing trace, if the trace queue is producing a larger volume of trace information than expected.

Permissions

Execute permissions for xp_trace_pausequeue default to members of the sysadmin fixed server role but can be granted to other users. Any person who defines a trace queue has the appropriate permissions to pause processing of the same trace queue.

Examples

This example pauses the specified 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_pausequeue @queue_handle

See Also