EnableStackOnMessage Property

Applies to TestComplete 14.72, last modified on December 24, 2020

Description

The EnableStackOnMessage property specifies whether TestComplete will track and save the call stack information for each informative message posted to the test log from a keyword test or script routine. The collected data is shown in the Call Stack panel of the test log. Using this information, you can determine the sequence of tests and script routines that led to the execution of the test (or routine) in which the message was posted.

Declaration

CallStackSettingsObjObj.EnableStackOnMessage

Read-Write Property Boolean
CallStackSettingsObjObj An expression, variable or parameter that specifies a reference to a CallStackSettingsObj object

Applies To

The property is applied to the following object:

Property Value

True, if TestComplete should collect the call stack information for each informative message posted to the log, or false otherwise.

Remarks

By default, the property’s value is false. You may want to set it to true to trace the call stack of informative messages. Note, however, that if your test posts a lot of informative messages to the log, then additional call stack data may significantly increase the size of the test log files.

The changes that you make to the call stack settings have effect only during the execution of one test item or one test (if you run the test from the test editor or the Project Explorer panel). When the next test item starts or when you run the test for the next time, the default settings will be used.

Example

The code below obtains information about the call stack settings, enables collecting the call stack information for the period when an informative message is being posted to the test log, posts the informative message to the test log and then disables collecting the call stack information.

JavaScript, JScript

function CallStackSet()
{
  // Obtains the call stack settings
  var StackSet = Log.CallStackSettings;
  // Enables collecting the call stack information for the period
  // when an informative message is being posted to the test log
  StackSet.EnableStackOnMessage = true;
  // ...
    Log.Message("A sample message.");
  // ...
  // Disables collecting the call stack information
  StackSet.EnableStackOnMessage = false;
}

Python

def CallStackSet():
  # Obtains the call stack settings
  StackSet = Log.CallStackSettings
  # Enables collecting the call stack information for the period
  # when an informative message is being posted to the test log
  StackSet.EnableStackOnMessage = True
  # ...
  Log.Message("A sample message.")
  # ...
  # Disables collecting the call stack information
  StackSet.EnableStackOnMessage = False

VBScript

Sub CallStackSet
  ' Obtains the call stack settings
  Set StackSet = Log.CallStackSettings
  ' Enables collecting the call stack information for the period
  ' when an informative message is being posted to the test log
  StackSet.EnableStackOnMessage = True
  ' ...
    Log.Message("A sample message.")
  ' ...
  ' Disables collecting the call stack information
  StackSet.EnableStackOnMessage = False
End Sub

DelphiScript

function CallStackSet;
var StackSet;
begin
  // Obtains the call stack settings
  StackSet := Log.CallStackSettings;
  // Enables collecting the call stack information for the period
  // when an informative message is being posted to the test log
  StackSet.EnableStackOnMessage := true;
  // ...
    Log.Message('A sample message.');
  // ...
  // Disables collecting the call stack information
  StackSet.EnableStackOnMessage := false;
end;

C++Script, C#Script

function CallStackSet()
{
  // Obtains the call stack settings
  var StackSet = Log["CallStackSettings"];
  // Enables collecting the call stack information for the period
  // when an informative message is being posted to the test log
  StackSet["EnableStackOnMessage"] = true;
  // ...
    Log["Message"]("A sample message.");
  // ...
  // Disables collecting the call stack information
  StackSet["EnableStackOnMessage"] = false;
}

See Also

Log Message Operation
Message Method
Test Results
Generic Test Log - Call Stack Panel

Highlight search results