SegmentPropagatorUpdateProgressTrackerAndReturnIfCanceled Method

A helper method to handle the progress tracker that the various Propagate methods have. Because how long propagation will take cannot be known ahead of time, the progress is reported as -1. You can however use the progress tracker to cancel propagation.

Namespace: AGI.Foundation.SegmentPropagation
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public static bool UpdateProgressTrackerAndReturnIfCanceled(
	ITrackCalculationProgress progressTracker
)

Public Shared Function UpdateProgressTrackerAndReturnIfCanceled ( 
	progressTracker As ITrackCalculationProgress
) As Boolean

public:
static bool UpdateProgressTrackerAndReturnIfCanceled(
	ITrackCalculationProgress^ progressTracker
)

static member UpdateProgressTrackerAndReturnIfCanceled : 
        progressTracker : ITrackCalculationProgress -> bool

Parameters

progressTracker: Type: AGI.FoundationITrackCalculationProgress
The progress tracker that can be used to cancel propagation.

Return Value

Type: Boolean
if propagation should stop; otherwise .

Reference

SegmentPropagator Class

AGI.Foundation.SegmentPropagation Namespace

SegmentPropagatorAddLanguageSpecificTextSet("LST8AEA1872_0?cpp=::|nu=.");UpdateProgressTrackerAndReturnIfCanceled Method

Parameters

Return Value

Reference

SegmentPropagatorUpdateProgressTrackerAndReturnIfCanceled Method