ClearHistory Method

In This Topic

Clears the history for the job, optionally resetting the statistics for the job.

Syntax

'Declaration
 
Public Sub ClearHistory( _
   ByVal options As HistoryClearOptions _
)

public void ClearHistory( 
   HistoryClearOptions options
)

public:
void ClearHistory( 
   HistoryClearOptions options
)

Remarks

Calling this method signals the server to purge the history and returns immediately; there may be a delay before the purge completes. If options contains ArcanaDevelopment.adTempus.Shared.HistoryClearOptions.ResetStatistics, the statistics tracked in the JobStatus are all reset to zero.

Clearing the history does not reset the instance numbering for the job back to 1.