Description

The LogResults object provides a scripting interface to a project’s logs that are displayed under the Project_Suite_Name Logs | Project_Name Logs node in the Project Explorer panel. These are top-level log items that can hold result of test runs for a whole project, its test items or project item’s elements (for instance, single script routines, low-level procedures, and so on).

The LogResults object maintains the list of a project’s top-level log items and contains properties that let you iterate through log items and access single top-level log items from scripts. This helps you process test results in a specific manner, for instance, to export them to a custom file format.

To obtain the reference to the LogResults object from scripts, use the Logs property of the Project object.

Members

Properties

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.");

}

LogResults Object

Description

Members

Example

See Also