Datasnap.Provider.TCustomProvider.InternalGetRecords
Delphi
function InternalGetRecords(Count: Integer; out RecsOut: Integer; Options: TGetRecordOptions; const CommandText: OleStr; var Params: OleVariant): OleVariant; virtual;
C++
virtual System::OleVariant __fastcall InternalGetRecords(int Count, /* out */ int &RecsOut, TGetRecordOptions Options, const System::WideString CommandText, System::OleVariant &Params);
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | protected | Datasnap.Provider.pas Datasnap.Provider.hpp |
Datasnap.Provider | TCustomProvider |
Description
Fournit l'implémentation sous-jacente de la méthode GetRecords.
La méthode GetRecords appelle InternalGetRecords pour assembler un paquet de données après l'appel à DoBeforeGetRecords afin d'appliquer CommandText et Params et générer un événement BeforeGetRecords. Telle qu'elle est implémentée dans TCustomProvider, InternalGetRecords renvoie toujours NULL. Les classes descendantes surchargent cette méthode pour extraire les enregistrements requis et les assembler en un paquet de données.
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 réel d'enregistrements extraits.
Options indique quelles informations doivent être ajoutées au paquet de données en plus des données. Peuvent être inclus grMetaData (inclut les métadonnées), grReset (lance les enregistrements fournisseurs avec le premier enregistrement de l'ensemble de données) et grXML (code le paquet de données en XML plutôt que sous forme d'OleVariant) ou grXMLUTF8 (identique à grXML à l'exception suivante : les caractères étendus sont codés en utilisant UTF8).
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é à un objet TTable, Params spécifie les valeurs de champ filtrant l'ensemble de résultats. A la sortie GetRecords, Params renvoie tous les paramètres de sortie.
Les enregistrements sont renvoyés sous la forme d'un paquet de données dans un variant.