CompareStrings

int CompareStrings (char *string#1, int string#1Index, char *string#2, int string#2Index, int caseSensitive);

Purpose

Compares the NUL–terminated string that starts at position string#1Index of string#1 to the NUL–terminated string that starts at position string#2Index of string#2. string#1Index and string#2Index are zero–based.

CompareStrings returns an integer value that indicates the lexicographic relationship between the two strings.

Parameters

Input
Name Type Description
string#1 string One of the two NUL–terminated strings whose contents are to be compared.
string#1Index integer Zero–based index specifying the location within string#1 at which to begin comparing bytes.
string#2 string One of the two NUL–terminated strings whose contents are to be compared.
string#2Index integer Zero–based index specifying the location within string#2 at which to begin comparing bytes.
caseSensitive integer Specifies whether alphabetic characters must have the same case to be considered equal.

If caseSensitive is zero, CompareStrings compares alphabetic characters without regard to case. If caseSensitive is a nonzero value, CompareStrings considers alphabetic characters equal only if they have the same case.

Return Value

Name Type Description
result integer Indicates the lexicographical relationship between string#1 and string#2.
Code Description
–1 Bytes from string#1 are less than bytes from string#2.
0 Bytes from string#1 are identical to bytes from string#2.
1 Bytes from string#1 are greater than bytes from string#2.