Debugger.EnableSqlTrace(Integer [, Boolean]) Method

  • Article

Version: Available or changed with runtime version 1.0.

Enables or verifies SQL tracing. If you enable SQL tracing, then SQL Server events for selected sessions on the server instance are collected.

Syntax

[IsEnabled := ]  Debugger.EnableSqlTrace(SessionID: Integer [, NewIsEnabled: Boolean])

Parameters

SessionID
 Type: Integer
The ID of the session for which you want to enable the SQL trace, or for which you want to verify if tracing is enabled.If you specify 0 and you specify the NewIsEnabled parameter, then tracing is enabled for all existing sessions and all new sessions on the current server instance. If you specify 0 and you omit the NewIsEnabled parameter, then the function returns true if tracing is enabled for new sessions on the current server instance. If the session ID that you specify does not exist and you specify the NewIsEnabled parameter, then a run-time error occurs. If the session ID that you specify does not exist and you do not specify the NewIsEnabled parameter, then the function returns false.

[Optional] NewIsEnabled
 Type: Boolean
If you specify the optional NewIsEnabled parameter, then the method sets whether tracing is enabled. true if you want to enable tracing for the specified session; false if you want to disable tracing. If you omit the NewIsEnabled parameter, then the function verifies if tracing is enabled.

Return Value

[Optional] IsEnabled
 Type: Boolean

Remarks

You use Microsoft SQL Server Profiler to view traces. For more information, see Using SQL Server Profiler. To start SQL Server Profiler, in SQL Server Management Studio, on the Tools menu, choose SQL Server Profiler.

You can also enable and disable SQL tracing by using the Start Full SQL Tracing and Stop Full SQL Tracing buttons on the Session List page.

Debugger Data Type
Get Started with AL
Developing Extensions