FireDAC.Stan.Option.TFDFormatOptions.SortLocale

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property SortLocale: TFDLocalID read GetSortLocale write SetSortLocale  stored IsSLS default LOCALE_USER_DEFAULT;

C++

__property unsigned SortLocale = {read=GetSortLocale, write=SetSortLocale, stored=IsSLS, default=1024};

Properties

Type Visibility Source Unit Parent
property published
FireDAC.Stan.Option.pas
FireDAC.Stan.Option.hpp
FireDAC.Stan.Option TFDFormatOptions

Description

Specifies a locale ID for the local sorting operations.

Use the SortLocale property to specify a locale ID for the local sorting operations. The default value is LOCALE.USER.DEFAULT. 

The local sorting is performed by the IndexFieldNames and Indexes properties. When the sorting is performed on a string column, the Windows API function CompareString is used. The string comparison is performed using the SortLocale locale. 

For TFDMemTable, TFDQuery, and TFDStoredProc the specifying of SortLocale is always optional. For TFDTable it may be required, when the database collation differs from the default locale. Additionally, SortOptions can be used. 

To specify a locale ID, the MAKELCID, MAKELANGID, and DownlevelLocaleNameToLCID Windows API functions can be used. To enable binary string comparision, specify 0.

See Also