Text::CompareText

Defined in: C4String.h

Compares two strings for equality.

Prototype

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

bool CompareText(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 CompareText function returns a boolean value indicating whether the two strings specified by the s1 and s2 parameters are equal. The comparison is case-sensitive.

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.