Datasnap.Provider.TCustomProvider.DoBeforeGetRecords
Delphi
procedure DoBeforeGetRecords(Count: Integer; Options: Integer; const CommandText: OleStr; var Params, OwnerData: OleVariant); virtual;
C++
virtual void __fastcall DoBeforeGetRecords(int Count, int Options, const System::WideString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData);
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
procedure function |
protected | Datasnap.Provider.pas Datasnap.Provider.hpp |
Datasnap.Provider | TCustomProvider |
Beschreibung
Erzeugt ein BeforeGetRecords-Ereignis.
DoBeforeGetRecords wird von der Methode GetRecords zum Erzeugen eines BeforeGetRecords-Ereignisses aufgerufen, bevor Daten abgerufen und zu einem Datenpaket zusammengestellt werden.
Count ist die Anzahl der angeforderten Datensätze. Wenn Count den Wert –1 enthält, werden alle Datensätze angefordert.
Options legt fest, ob das Datenpaket Metadaten enthält, ob das Datenpaket mit dem ersten Datensatz beginnt und ob das Datenpaket in XML codiert wird. Einzelheiten dazu finden Sie bei der Methode GetRecords.
CommandText gibt entweder eine optionale SQL-Anweisung, die die SQL-Anweisung einer verbundenen Abfrage ersetzt, oder den Namen einer Tabelle oder einer Stored Procedure an, die die verbundene Tabelle oder Stored Procedure ersetzt. Wenn poAllowCommandText nicht in Options enthalten ist oder der Provider keine Eigenschaft Options besitzt, wird dieser Parameter ignoriert.
Params enthält die Parameterwerte, die in CommandText oder in die Abfrage oder in die Stored Procedure vor dem Abrufen der Daten für das Datenpaket eingetragen werden sollen.
OwnerData stellt für die Ereignisbehandlungsroutine BeforeGetRecords benutzerdefinierte Informationen bereit. In der Ereignisbehandlungsroutine kann dieser Wert geändert werden. Der Rückgabewert wird dann an eine AfterGetRecords-Ereignisbehandlungsroutine übergeben und anschließend an den Aurrufer der Methode GetParams zurückgeliefert.
Gemäß der Implementierung in TCustomProvider werden die Parameter Count, Options, CommandText und Params ignoriert. Abgeleitete Klassen können diese Werte vor dem Erzeugen eines BeforeExecute-Ereignisses eintragen.