Datasnap.Provider.TCustomProvider.GetRecords
Delphi
function GetRecords(Count: Integer; out RecsOut: Integer; Options: Integer): OleVariant; overload;
function GetRecords(Count: Integer; out RecsOut: Integer; Options: Integer; const CommandText: string; var Params, OwnerData: OleVariant): OleVariant; overload;
C++
System::OleVariant __fastcall GetRecords(int Count, /* out */ int &RecsOut, int Options)/* overload */;
System::OleVariant __fastcall GetRecords(int Count, /* out */ int &RecsOut, int Options, const System::UnicodeString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData)/* overload */;
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | public | Datasnap.Provider.pas Datasnap.Provider.hpp |
Datasnap.Provider | TCustomProvider |
Description
Extrait un paquet de données qui représente les données associées à un fournisseur.
Appelez GetRecords pour extraire un paquet de données contenant un nombre spécifié d'enregistrements. GetRecords génère un événement BeforeGetRecords, assemble un paquet de données puis génère un événement AfterGetRecords.
Count précise le nombre d'enregistrements à extraire. Si Count a la valeur -1, tous les enregistrements sont extraits. Si Count a la valeur 0, seules les métadonnées sont extraites. Si Count est positif, seul le nombre d'enregistrements précisé est extrait.
RecsOut renvoie le nombre d'enregistrements effectivement contenus dans le paquet de données.
Options indique quelles informations doivent être ajoutées au paquet de données en plus des données. Il s'agit d'une combinaison de constantes GetRecordOption. Par exemple, la valeur suivante demande des métadonnées ainsi qu'un paquet de données codé en XML :
MetaDataOption + XMLOption
MetaDataOption || XMLOption
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 spécifie toutes les valeurs de paramètre devant être appliquées à CommandText, à une requête associée ou à une procédure stockée. Si le fournisseur est associé à une TTable, Params spécifie les valeurs de champ filtrant l'ensemble résultat. A la sortie de GetRecords, Params renvoie tous les paramètres de sortie.
OwnerData contient des informations personnalisées qui sont fournies par le gestionnaire d'événement BeforeGetRecords d'un ensemble de données client. Ces informations sont transmises au gestionnaire d'événement BeforeGetRecords du fournisseur puis renvoyées par le gestionnaire d'événement AfterGetRecords du fournisseur.
Les enregistrements sont renvoyés sous la forme d'un paquet de données dans un variant.
Remarque : GetRecords génère toujours les événements BeforeGetRecords et AfterGetRecords, même si vous utilisez la syntaxe qui n'inclut pas de paramètre OwnerData. Dans ce cas, la valeur de OwnerData est nil (Delphi) ou NULL (C++) à l'entrée du gestionnaire d'événement BeforeGetRecords et est rejetée en sortie du gestionnaire d'événement AfterGetRecords.
Conseil : Si le fournisseur fait partie d'un serveur d'applications sans état, rien ne garantit que le fournisseur sera positionné sur l'enregistrement souhaité avant qu'il ne crée un paquet de données. Utilisez un gestionnaire d'événement BeforeGetRecords pour positionner le curseur avant l'appel à GetRecords.