VerifyExpression()
Summary
Verifies the validity of an expression.
Changes
Added Fields option to Version 6.0/2012.
Syntax
info_array = VerifyExpression(string view_name, string expression [, array options])
| Argument | Contents |
|---|---|
| view_name | The view on which the expression is evaluated |
| expression | The expression to be evaluated |
| Option | Type | Contents |
|---|---|---|
| Fields | Boolean | If "True" the return array has a third element, an array containing a list of the full field specs of all fields in the view referenced by expression. The default value of "False" returns a two element array. |
Returns
An array of two (2) or three (3) elements, based on the Fields option, giving information about the expression.
| Element | Type | Contents |
|---|---|---|
| 1 | String | The data type of the expression: "INTEGER", "STRING" and "REAL" |
| 2 | Integer | The suggested display width for the expression, if used in an expression field |
| 3 | Array | An array of strings, included if the Fields option is "True," containing a list of the full field specs of all fields in the view referenced by expression |
Notes
-
The options array is an optional argument.
-
If VerifyExpression() does not signal an error, the expression is valid.
-
Both the data type and display width returned by VerifyExpression() may be used as options to CreateExpression().
Error Codes
| Error Type | Meaning |
|---|---|
| Error | The expression is null or invalid or its type cannot be determined |
| NotFound | The specified view does not exist, or the input view_name is null and there is no current view |
See Also
| Function | Summary |
|---|---|
| CreateExpression() | Creates an expression (formula) field on a view |
| GetExpressions() | Returns an array of all expression fields defined in a view |
| GetExpressionInfo() | Returns information about an expression (formula) field |