SSGetIteration, SSSetIteration Functions
Applies To
fpSpread DLL control
Description
Set or return the number of iterations for circular references.
Syntax
BOOL SSGetIteration(HWND hWnd, LPSHORT lpnMaxIterations, LPDOUBLE lpdfMaxChange);
BOOL SSSetIteration(HWND hWnd, BOOL bIteration, short nMaxIterations, double dfMaxChange);
BOOL TSpread::GetIteration(LPSHORT lpnMaxIterations, LPDOUBLE lpdfMaxChange);
BOOL TSpread::SetIteration(BOOL bIteration, short nMaxIterations, double dfMaxChange);
Parameters
The SSGetIteration function has the following parameters:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| lpnMaxIterations | Maximum number of iterations |
| lpdfMaxChange | Reserved for future use |
The SSSetIteration function has the following parameters:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| bIteration | Determines whether circular references are evaluated (The default value is FALSE.) |
| nMaxIterations | Maximum number of iterations (The default value is 1.) |
| dfMaxChange | Reserved for future use |
Remarks
This function is applied to the entire workbook, including all sheets in the control.
The SSSetIteration function sets iteration options for circular references in formulas. A circular reference is when a formula in a cell refers to its own cell. For example, the formula (A1*B1) is circular if it is in cell A1 or B1.
If the bIteration parameter is set to TRUE, the control uses iterations to evaluate recursive formulas. If the bIteration parameter is set to FALSE, the control does not evaluate recursive formulas.
The iteration process stops after the number of iterations specified by the nMaxIterations parameter.
Return Value
SSGetIteration: TRUE if recursive formulas are being evaluated; FALSE if they are not being evaluated.
SSSetIteration: The previous value of the bIterations parameter; that is, TRUE if recursive formulas were being evaluated, FALSE if they were not.
See Also
Using Circular References in Formulas
ActiveX Correspondence
SSGetIteration: GetIteration method
SSSetIteration: SetIteration method