xp_trace_sethpidfilter (T-SQL)

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

Syntax

xp_trace_sethpidfilter {queue_handle, process_ID}

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.

process_ID

Is an integer specifying the host process ID. Host process IDs can be found in the sysprocesses system table.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_sethpidfilter returns this message:

The command(s) completed successfully.

Permissions

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

Examples

This example configures the host process ID filter value 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_sethpidfilter @queue_handle,

    5199

See Also