Table of Contents

TUserDefinedFunction.TryGetBoolean Method

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

Syntax

Unit: FlexCel.Core

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

Returns

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

See also