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);
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
procedure function |
protected | Datasnap.Provider.pas Datasnap.Provider.hpp |
Datasnap.Provider | TCustomProvider |
Description
Génère un événement BeforeGetRecords.
La méthode GetRecords appelle DoBeforeGetRecords pour générer l'événement BeforeGetRecords avant qu'elle n'extraie les données et les assemble en un paquet de données.
Count représente le nombre d'enregistrements requis. Si Count vaut –1, tous les enregistrements sont requis.
Options indique si le paquet de données doit inclure les métadonnées, s'il doit commencer par le premier enregistrement et s'il doit être codé en XML. Pour plus de détails, voir la méthode GetRecords.
CommandText spécifie une instruction SQL facultative qui remplace le SQL d'une requête associée ou encore le nom d'une table ou d'une procédure stockée qui remplace la table associée ou la procédure stockée. Ce paramètre est ignoré si la propriété Options n'inclut pas poAllowCommandText ou si le fournisseur ne possède pas de propriété Options.
Params contient les valeurs de paramètres qui doivent être appliquées à CommandText ou à une requête ou procédure stockée avant l'extraction des données et leur assemblage en un paquet de données.
OwnerData fournit les informations personnalisées au gestionnaire d'événement BeforeGetRecords. Le gestionnaire d'événement peut modifier cette valeur. La valeur renvoyée est ensuite transmise à un gestionnaire d'événement AfterGetRecords puis renvoyée (facultatif) à l'appelant de la méthode GetRecords.
Telles qu'implémentées dans TCustomProvider, Count, Options, CommandText et Params sont ignorées. Les classes descendantes peuvent appliquer ces valeurs avant de générer l'événement BeforeExecute.