PurgeRuns Method

Description

Deletes the specified runs.

Syntax

Visual Basic
Public Sub PurgeRuns( _ ByVal TestSetFilter As String, _ ByVal KeepLast As Long, _ ByVal DateUnit As Variant, _ ByVal UnitCount As Long, _ ByVal StepsOnly As Boolean _ )

Visual Basic

Public Sub PurgeRuns( _
   ByVal TestSetFilter As String, _
   ByVal KeepLast As Long, _
   ByVal DateUnit As Variant, _
   ByVal UnitCount As Long, _
   ByVal StepsOnly As Boolean _
)

Parameters

TestSetFilter

The filter specifying the test sets from which the runs should be deleted. The filter can be a list of cycle IDs like "1,5,78,14", a status like "CY_STATUS='Open'", or a TDFilter.Text.

KeepLast

The number of most recent test instance runs not to purge.

DateUnit

Either a date string, in which case runs before this date are purged, or a unit code used to interpret the unit count. A unit code is one of:

1 for Days
2 for Weeks
3 for Months
4 for Years

UnitCount

If DateUnit is not a date string, this is the number of units. For example, if DateUnit is 1 and UnitCount is 5, purge all runs older than 5 days.

StepsOnly

If True, purge only the steps, but not the runs. If False, purge both the runs and steps.

Remarks

KeepLast overrides OlderThan. For example, if KeepLast is 10, OlderThan is 2 and UnitCount is 5, the meaning is "Purge all runs older than 5 weeks, but keep the last 10 runs for each test instance regardless of age".

PurgeRuns2 extends PurgeRuns to enable filtering by Run fields.