Table of Contents

TUserDefinedFunction.TryGetString Method

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

Syntax

Unit: FlexCel.Core

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

Returns

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

See also