PerformCalculations Method

Forces recalculation of all dirtied items in the Calculation Network.

Syntax

Visual Basic

'Declaration
 
Public Function PerformCalculations( _
   Optional ByVal maxTimeInMillis As Long _
) As Boolean

C#

public bool PerformCalculations( 
   long maxTimeInMillis
)

Parameters

maxTimeInMillis

Number of milliseconds to allow for calculations before control returns to the caller (to wait indefinitely, specify 0.)

Return Value

Returns a boolean indicating if anything in the calculation network remains dirty.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	Thrown when the value supplied for millis is either less than 0, or too great to convert into a number of clock ticks. The precise upper bound of millis may vary depending upon the granularity of the machine's hardware clock, but it exceeds any amount of time which would be a sensible argument (instead, use 0 to indicate an indefinite wait).

Remarks

Developers can use this method to limit the amount of time in the time slice calcmanager spends performing it's calculations. If all calculations have been completed before this time interval elapses, control returns immediately to the caller. Setting this interval too small can lead to excessive task-switching that would make the calculation complete more slowly than it ordinarily would have completed, therefore developers are advised to allot as much time as the user-responsiveness of the application permits.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2