Text::CompareTextLessEqual

Defined in: C4String.h

Determines whether one string precedes another or the two strings are equal.

Prototype

bool CompareTextLessEqual(const char *s1, const char *s2);

bool CompareTextLessEqual(const char *s1, const char *s2, int32 max);

Parameters

`s1`	A pointer to the first character string.
`s2`	A pointer to the second character string.
`max`	The maximum number of bytes to compare.

Description

The CompareTextLessEqual function returns a boolean value indicating whether the string specified by the s1 parameter precedes the string specified by the s2 parameter in lexicographical order, or the two strings are equal.

In general, both strings should be null-terminated by a zero byte. The comparison only goes as far as the length of the shorter string. If the max parameter is specified, then at most max bytes of each string are compared, even if both strings are longer.