strcomp.h file | source file

This header defines the StringComparator intrinsic class.

Summary of Classes

`StringComparator`

Summary of Global Functions

(none)

Summary of Macros

`StrCompCaseFold StrCompMatch StrCompTrunc`

Summary of Enums

(none)

Summary of Templates

(none)

Global Functions

(none)

Macros

`StrCompCaseFold` | `strcomp.h[129]`

`0x0002`
Case folding - this flag is set when the two values match, but one or more characters differ in case (in other words, an upper-case letter in the input string matched a lower-case letter in the dictionary string, or vice versa).

`StrCompMatch` | `strcomp.h[121]`

`0x0001`
Match - this flag is set in the return code for all matching strings. (This flag isn't as useless as it might sound; its purpose is to ensure that the return value from matchValues() is non-zero for all matches, even when no other flag values are applicable.)

`StrCompTrunc` | `strcomp.h[140]`

`0x0004`
Truncation - this flag is set when the input string is shorter than the value string (but matches the dictionary completely up to the input string's full length, and is at least as long as the truncation length specified in the constructor). This flag can only be returned when truncation is allowed (as indicated by a non-zero truncation length in the constructor), because truncated strings will never match at all when truncation isn't allowed.

Enums

(none)

Templates

(none)

TADS 3 Library Manual
Generated on 8/21/2012 from TADS version 3.1.2