FireDAC.Stan.Util.FDCompareWideStr

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function FDCompareWideStr(const AStr1, AStr2: PWideChar; ALen1, ALen2: Integer; ALocale: TFDLocalID; ANoCase, APartial, ANoSymbols: Boolean): Integer;

C++

extern DELPHI_PACKAGE int __fastcall FDCompareWideStr(const System::WideChar * AStr1, const System::WideChar * AStr2, int ALen1, int ALen2, unsigned ALocale, bool ANoCase, bool APartial, bool ANoSymbols);

Properties

Type Visibility Source Unit Parent
function public
FireDAC.Stan.Util.pas
FireDAC.Stan.Util.hpp
FireDAC.Stan.Util FireDAC.Stan.Util

Description

FDCompareWideStr compares the values of AStr1 and AStr2 parameters.

Use FDCompareWideStr to compare two PWideChar objects. The return value is indicated in the following table.

Return value Condition

<0

AStr1 sorts before AStr2.

=0

AStr1 is the same as AStr2.

>0

AStr1 sorts after AStr2.

The compare operation can be customized by giving proper values to its parameters (ANoCase - case-sensitivity, APartial - partial comparison, ANoSymbols - symbols and spaces). The ALen1 and ALen2 parameters represent the length of AStr1 and AStr2.

See Also