For ICmQueueSweep, the maximum number of times a dequeue operation for a queue sweep will be retried following a failure. If this property is set to zero, there is no limit on the maximum number of failures.

When QueueEntryStatus on a queue entry (represented by a ICmAbstractQueueEntry subclass) is set to FAILED, then the sweep service no longer selects the entry for processing. When the queue sweep handler reports a failure of processing, the sweep service increments the FailureCount property on the queue entry. If the new value equals or exceeds the current MaximumFailures property value on the ICmQueueSweep object controlling the sweep, then the QueueEntryStatus property is set to FAILED.

The QueueEntryStatus property is also set to FAILED when a queue sweep handler sets the processing outcome of the entry to SweepItemOutcome.FAILED_NO_RETRY.

To restart processing of a queue entry with a status of FAILED, reset the FailureCount property on the queue entry to zero.

For ICmBackgroundSearch, the maximum number of failures tolerated by the sweep service before the CmBackgroundSearch instance is terminated. If this property is set to zero, there is no limit to the maximum number of failures.

Namespace:  FileNet.Api.Sweep
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Property MaximumFailures As Nullable(Of Integer)
C#
Nullable<int> MaximumFailures { get; set; }
Visual C++
property Nullable<int> MaximumFailures {
	Nullable<int> get ();
	void set (Nullable<int> value);
}
JavaScript
function get_maximumFailures();
function set_maximumFailures(value);

ToggleRemarks

ToggleSee Also