TUserDefinedFunction.TryGetArray Method

Tries to retrieve an array from a parameter, and return it if it can be converted or an error if not.

Syntax

Unit: FlexCel.Core

class function TUserDefinedFunction.TryGetArray(const xls: TExcelFile; const param: TFormulaValue; out ResultValue: TArray<TArray<TFormulaValue>>; 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 TArray<​TArray<​TFormula​Value>​> Value of the parameter as an array. If TryGetArray returns false, this value is undefined.
out ResultError TFlxFormulaError​Value Value of the error when converting the parameter. If TryGetArray returns true (there was no error), this value is undefined.

Returns

True if the parameter can be converted to an array, false if there was an error.

See also