Datasnap.Provider.TDataSetProvider.DoBeforeGetRecords

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

procedure DoBeforeGetRecords(Count: Integer; Options: Integer;  const CommandText: OleStr; var Params, OwnerData: OleVariant); override;

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 TDataSetProvider

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. Dieser Parameter wird von TDataSetProvider nicht verwendet.

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. Dieser Parameter wird in TDataSetProvider von DoBeforeGetRecords ignoriert.

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 Options poAllowCommandText enthält, sendet DoBeforeGetRecords CommandText an die zugehörige Datenmenge, damit die Datensatzmenge erstellt werden kann.

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. DoBeforeGetRecords weist diese Parameterwerte der Datenmenge zu (wenn erforderlich).

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.

Siehe auch