xp_trace_setntdmfilter (T-SQL)

Specifies the existing Microsoft® Windows NT® domain name filter, or the existing Windows NT domains 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 domains, if any, and does not capture the required information for the excluded Windows NT domains, if any.

Syntax

xp_trace_setntdmfilter {queue_handle, 'include_domains',
    'exclude_domains'}

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_domains'

Is a string value that represents the Windows NT domain name include filter. The Windows NT domain name include filter indicates the Windows NT domains, 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 domains to include in the trace. If NULL, there are no restrictions on Windows NT domains to include for the specified event classes.

---

Note Windows NT domain values can be obtained either from knowledge of the domain names or from the sysprocesses system table.

---

'exclude_domains'

Is a string value that represents the Windows NT domain name exclude filter. The Windows NT domain name exclude filter indicates the Windows NT domains, 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 domains to exclude in the trace. If NULL, there are no excluded Windows NT domains for the specified event classes.

Return Code Values

0 (success) or >1 (failure)

Result Sets

xp_trace_setntdmfilter returns this message:

The command(s) completed successfully.

Remarks

To further filter a trace, see one of the xp_trace_set*filter procedures.

Generate the event class list by executing xp_trace_geteventnames.

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

Permissions

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

Examples

This example configures the Windows NT domain name filter value for the trace queue. The Windows NT domains to include are sales and marketing, and the domain to exclude is the accounting domain.

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

    'sales%;marketing%',

    'accounting%'

See Also