System.Classes.TStrings.CompareStrings

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function CompareStrings(const S1, S2: string): Integer; virtual;

C++

virtual int __fastcall CompareStrings(const System::UnicodeString S1, const System::UnicodeString S2);

Properties

Type Visibility Source Unit Parent
function protected
System.Classes.pas
System.Classes.hpp
System.Classes TStrings

Description

Compares two strings.

TStrings uses CompareStrings internally to compare the values of strings that appear in the list. For example, the IndexOf and IndexOfName methods use CompareStrings to compare a specified string with the strings in the list.

S1 and S2 are the strings to compare.

CompareStrings returns a value less than 0 if S1 < S2, 0 if S1 == S2, and a value greater than 0 if S1 > S2.

As implemented in TStrings, CompareStrings uses the global AnsiCompareText function, which compares strings case insensitively. Some descendant classes override this method to change the way strings are compared (for example, to introduce case sensitivity).

See Also