LogItem Object

Applies to TestComplete 15.0, last modified on October 22, 2021

Description

A LogItem object provides a scripting interface to a project’s log item. Log items are displayed in the test log panel. They are organized in a tree-like structure. At that, each log item of any level (topmost log items as well as child items) are represented as the LogItem object.

To obtain the top-level log item (the tree root node) from scripts, use the LogItem property of the LogResults object. To obtain a child log item, use the Child property of the parent LogItem object.

The LogItem object also contains properties that let you access a log item’s dataset, that is, results displayed for the given log item in additional log panels. To obtain the log item’s dataset, use the Data property.

Note that the log item can hold several datasets.

Members

Example

The code below obtains a collection of logs that belong to the current project and posts the name and status of each log item to the test log.

JavaScript, JScript

function LogResultsExample()
 {
   // Obtains a collection of logs
   var LogsCol = Project.Logs;
   // Obtains the total number of log items in the collection
   var Num = LogsCol.LogItemsCount;
   
   if ( Num > 0 )
   {
     // Iterates through the items
     for (var i = 0; i < Num; i++)
     {
       var LogItem = LogsCol.LogItem(i);
       var Name = LogItem.Name;
       var Status = LogItem.Status;
       Log.Message("The " + Name + " item has the following status: " + Status);
     }
   }
   else 
     Log.Message("The collection has no log items.");

 }

Python

def LogResultsExample():
  # sObtains a collection of logs
  LogsCol = Project.Logs
  # Obtains the total number of log items in the collection
  Num = LogsCol.LogItemsCount
  if Num > 0:
    # Iterates through the items
    for i in range(0, Num):
      LogItem = LogsCol.LogItem[i]
      Name = LogItem.Name
      Status = LogItem.Status
      Log.Message("The " + Name + " item has the following status: " + str(Status))
  else:
    Log.Message("The collection has no log items.")

VBScript

Sub LogResultsExample()

  ' Obtains a collection of logs
  Set LogsCol = Project.Logs
  ' Obtains the total number of log items in the collection
  Num = LogsCol.LogItemsCount
  
  If Num > 0 Then
    ' Iterates through the items
    For i = 0 to (Num - 1)
      Set LogItem = LogsCol.LogItem(i)
      Name = LogItem.Name
      Status = LogItem.Status
      Log.Message("The " & Name & " item has the following status: " & Status)
    Next
  Else 
    Log.Message("The collection has no log items.")
  End If
  
End Sub

DelphiScript

function LogResultsExample;
var LogsCol, Num, i, LogItem, Name, Status;
begin

   // Obtains a collection of logs
   LogsCol := Project.Logs;
   // Obtains the total number of log items in the collection
   Num := LogsCol.LogItemsCount;
   
   if ( Num > 0 ) then
   begin
     // Iterates through the items
     for i := 0 to (Num - 1) do
     begin
       LogItem := LogsCol.LogItem[i];
       Name := LogItem.Name;
       Status := LogItem.Status;
       Log.Message('The ' + Name + ' item has the following status: ' + Status);
     end
   end
   else 
     Log.Message('The collection has no log items.');
end;

C++Script, C#Script

function LogResultsExample()
 {
   // Obtains a collection of logs
   var LogsCol = Project["Logs"];
   // Obtains the total number of log items in the collection
   var Num = LogsCol["LogItemsCount"];
   
   if ( Num > 0 )
   {
     // Iterates through the items
     for (var i = 0; i < Num; i++)
     {
       var LogItem = LogsCol["LogItem"](i);
       var Name = LogItem["Name"];
       var Status = LogItem["Status"];
       Log["Message"]("The " + Name + " item has the following status: " + Status);
     }
   }
   else 
     Log["Message"]("The collection has no log items.");
   
}

See Also

Test Results
Access Test Log Contents from Tests
LogResults Object

Highlight search results