xp_trace_startconsumer (T-SQL)

Starts the specified consumer (set with xp_trace_setqueuedestination) that consumes events from the queue and sends it to the destination specified in the queue definition.

Syntax

xp_trace_startconsumer {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 placed in an output parameter by xp_trace_addnewqueue.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_startconsumer returns this message:

The command(s) completed successfully.

Permissions

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

Examples

This example starts the consumer 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_setqueuedestination @queue_handle,
    2,
    1,
    NULL,
    'c:\temp\demo.trc'

EXEC xp_trace_startconsumer @queue_handle

See Also