xp_trace_setntnmfilter (T-SQL)

Specifies the Microsoft® Windows NT® username filter or the Windows NT usernames to include or exclude for the events specified. Microsoft SQL Server™ captures the required information, configured by executing xp_trace_seteventclassrequired, for the included Windows NT usernames, if any, and does not capture the required information for the excluded Windows NT usernames, if any.

Syntax

xp_trace_setntnmfilter {queue_handle, 'include_NTusers',
    'exclude_NTusers'}

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.

'include_NTusers'

Is a string value that represents the Windows NT username include filter. The Windows NT username include filter indicates the Windows NT users, separated by semicolons (;), that should be considered when capturing data previously determined by sp_seteventclassrequired. The % wildcard character can be used in specifying the Windows NT users to include in the trace. If NULL, there are no restrictions on Windows NT users to include for the specified event classes.

'exclude_NTusers'

Is a string value that represents the Windows NT username exclude filter. The Windows NT username exclude filter indicates the Windows NT users, separated by semicolons (;), that should not be considered when capturing data previously determined by sp_seteventclassrequired. The % wildcard character can be used in specifying the Windows NT users to exclude in the trace. If NULL, there are no excluded Windows NT users for the specified event classes.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_setntnmfilter returns this message:

The command(s) completed successfully.

Remarks

Generate the event class list by executing xp_trace_geteventnames.

When you specify one or more usernames to include, all other usernames are excluded.

Permissions

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

Examples

This example configures the Windows NT username filter value for trace queue. The usernames to include are nancyd and stevenb. The username janetl is excluded.

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_setntnmfilter @queue_handle,

    'nancyd%;stevenb%',

    'janetl%'

See Also