Datasnap.Provider.TDataSetProvider.DoBeforeGetRecords

De RAD Studio API Documentation
Aller à : navigation, rechercher

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);

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
protected
Datasnap.Provider.pas
Datasnap.Provider.hpp
Datasnap.Provider TDataSetProvider

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. TDataSetProvider n'utilise pas ce paramètre.

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. Dans TDataSetProvider, DoBeforeGetRecords ignore ce paramètre.

CommandText spécifie une instruction SQL facultative qui remplace le SQL d'une requête associée, ou bien le nom d'une table ou d'une procédure stockée qui remplace la table associée ou la procédure stockée. Si Options inclut poAllowCommandText, DoBeforeGetRecords envoie CommandText à l'ensemble de données associé afin qu'il génère l'ensemble des enregistrements.

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. DoBeforeGetRecords affecte ces valeurs à l'ensemble de données associé, si nécessaire.

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.

Voir aussi