TUserDefinedFunction.TryGetDate Method
Tries to retrieve a date/time from a parameter, and return it if it can be converted or an error if not.
Syntax
Namespace: FlexCel.Core
public static Boolean TryGetDate(ExcelFile xls, Object param, Boolean SuppressTime, out DateTime ResultValue, out TFlxFormulaErrorValue ResultError)Parameters
| <-> | Parameter | Type | Description |
|---|---|---|---|
| xls | ExcelFile | ExcelFile used to read the parameter when it is a cell reference. | |
| param | Object | One of the parameters passed to Evaluate | |
| SuppressTime | Boolean | If true, the date returned will have the time set to 0:00 no matter the real value. | |
| out | ResultValue | DateTime | Value of the parameter as double. If TryGetDate returns false, this value is undefined. |
| out | ResultError | TFlxFormulaErrorValue | Value of the error when converting the parameter. If TryGetDate returns true (there was no error), this value is undefined. |
Returns
True if the parameter can be converted to a datetime, false if there was an error.