TUserDefinedFunction.TryGetDouble Method
Tries to retrieve a double from a parameter, and return it if it can be converted or an error if not.
Syntax
Unit: FlexCel.Core
class function TUserDefinedFunction.TryGetDouble(const xls: TExcelFile; const param: TFormulaValue; out ResultValue: Double; out ResultError: TFlxFormulaErrorValue): Boolean; static;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | xls | TExcelFile | ExcelFile used to read the parameter when it is a cell reference. |
const | param | TFormulaValue | One of the parameters passed to Evaluate |
out | ResultValue | Double | Value of the parameter as double. If TryGetDouble returns false, this value is undefined. |
out | ResultError | TFlxFormulaErrorValue | Value of the error when converting the parameter. If TryGetDouble returns true (there was no error), this value is undefined. |
Returns
True if the parameter can be converted to a double, false if there was an error.