Show: Delphi
C++
Display Preferences
Data.DB.IProviderSupport.PSGetDefaultOrder
From XE2 API Documentation
Delphi
function PSGetDefaultOrder: TIndexDef;
C++
virtual TIndexDef* __fastcall PSGetDefaultOrder(void) = 0 ;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Data.DB.pas Data.DB.hpp |
Data.DB | IProviderSupport |
Description
Returns the definition of an index that imposes the default order on the data included in data packets.
The provider component calls PSGetDefaultOrder to generate a default index, called DEFAULT_ORDER, for the records that appear in data packets. This index defines the default sort order for records when they appear in the client dataset on the client.
PSGetDefaultOrder creates a TIndexDef object to describe the default index. The provider that calls PSGetDefaultOrder subsequently frees this TIndexDef object.