Inspection |
Top Previous Next |
These functions are used to "inspect" or "test" the results of an expression, generally for use in conjunction with Flow type functions.
| Function: | Between |
| Result-type: | Boolean |
| Arguments: | eTest, eFirst, eLast |
| Description: | Returns TRUE if eTest is between eFirst and eLast, non-inclusive -- e.g. Between(2, 2, 3) would return False because 2 is not greater than 2. Arguments can be text, numbers, dates, or boolean (but must all be the same type) |
| Function: | Empty |
| Result-type: | Boolean |
| Arguments: | eExpression |
| Description: | Returns TRUE if the argument is an empty text string, 0 value, invalid date, or FALSE boolean value |
| Function: | FieldIsBlank |
| Result-type: | Boolean |
| Arguments: | rRecord, cFieldName |
| Description: | Returns 'T' if the specified field is designated as a 'blank' value (not set) -- this could be different than a '0' numeric value or FALSE boolean |
| Function: | FieldIsEnabled |
| Result-type: | Boolean |
| Arguments: | rRecord, cFieldName |
| Description: | Returns 'T' if the specified field is enabled for the table that the given record belongs to |
| Function: | IsAlpha |
| Result-type: | Boolean |
| Arguments: | cCharacter |
| Description: | Returns TRUE if the character is an alphabetic character (a-z or A-Z) |
| Function: | IsDigit |
| Result-type: | Boolean |
| Arguments: | cCharacter |
| Description: | Returns TRUE if the character is a digit (0-9) |
| Function: | IsLower |
| Result-type: | Boolean |
| Arguments: | cCharacter |
| Description: | Returns TRUE if the character is a lower-case alphabetic character (a-z) |
| Function: | IsUpper |
| Result-type: | Boolean |
| Arguments: | cCharacter |
| Description: | Returns TRUE if the character is an upper-case alphabetic character (A-Z) |
| Function: | Len |
| Result-type: | Numeric |
| Arguments: | cText |
| Description: | Returns the length of the text (number of characters) |
| Function: | Like |
| Result-type: | Boolean |
| Arguments: | cTextWild, cText |
| Description: | Returns TRUE if cText matches cTextWild, with '?' and '*' wild-card character support in cTextWild. Case sensitive. |
| Function: | LoopFindNth |
| Result-type: | Unknown |
| Arguments: | nStart, nEnd, nOccurrence, cPlaceholder, cQuotedExpression, cQuotedCondition [, cQuotedDefault] |
| Description: | Repeats execution of the quoted condition, replacing the placeholder text with the index numbers in the given start-end range, until the condition returns true nOccurrence times. Then it will return the results of the quoted expression evaluated for that index (or a NULL/error return if not found unless there's a default). For example, it could be used to return the value of the 3rd Charge transaction for a reservation |
| Function: | LoopFindNthIndex |
| Result-type: | Numeric |
| Arguments: | nStart, nEnd, nOccurrence, cPlaceholder, cQuotedCondition |
| Description: | Repeats execution of the quoted condition, replacing the placeholder text with the index numbers in the given start-end range, until the condition returns true nOccurrence times. Then it will return that index number (or nStart-1 if it passes the end). For example, it could be used to return the index number of the 3rd Charge transaction for a reservation |
| Function: | Occurs |
| Result-type: | Numeric |
| Arguments: | cText, cTextToFind |
| Description: | Returns the number of times cTextToFind occurs in cText |
| Function: | Sign |
| Result-type: | Numeric |
| Arguments: | nValue |
| Description: | Returns -1 if the value is less than 0, 1 if the value is greater than 0, or 0 if it's exactly 0 |
| Function: | TableFieldIsEnabled |
| Result-type: | Boolean |
| Arguments: | cTableName, cFieldName |
| Description: | Returns 'T' if the specified field is enabled for the table |
| Function: | VarType |
| Result-type: | Text |
| Arguments: | eExpression |
| Description: | Returns a character representing the type of value the argument represents. 'C' = text (character), 'N' = numeric, 'D' = date, 'B' = boolean, 'R' = record, 'X' = null (error), 'U' = unknown |