Datasnap.DBClient.TCustomClientDataSet.SetRange
| [–] Properties | |
|---|---|
| Type: procedure function
| |
| Visibility: public | |
| Source: Datasnap.DBClient.pas Datasnap.DBClient.hpp
| |
| Unit: Datasnap.DBClient | |
| Parent: TCustomClientDataSet | |
Delphi
procedure SetRange(const StartValues, EndValues: array of const);
C++
void __fastcall SetRange(const System::TVarRec *StartValues, const System::NativeInt StartValues_High, const System::TVarRec *EndValues, const System::NativeInt EndValues_High);
Description
Sets the starting and ending values of a range, and applies it.
Call SetRange to specify a range and apply it to the dataset. The new range replaces the currently specified range, if any.
StartValues indicates the field values that designate the first record in the range. In C++, StartValues_Size is the index of the last value in the StartValues array.
EndValues indicates the field values that designate the last record in the range. In C++, EndValues_Size is the index of the last value in the EndValues array.
SetRange combines the functionality of SetRangeStart, SetRangeEnd, and ApplyRange in a single procedure call. SetRange performs the following functions:
- Puts the dataset into dsSetKey state.
- Erases any previously specified starting range values and ending range values.
- Sets the start and end range values.
- Applies the range to the dataset.
After a call to SetRange, the cursor is left on the first record in the range.
If either StartValues or EndValues has fewer elements than the number of fields in the current index, then the remaining entries are set to NULL.