Datasnap.Provider.TDataSetProvider.InternalGetRecords

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function InternalGetRecords(Count: Integer; out RecsOut: Integer;  Options: TGetRecordOptions; const CommandText: OleStr; var Params: OleVariant): OleVariant; override;

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 TDataSetProvider

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. InternalGetRecords appelle CreateDataPacket pour créer un paquet de données reflétant les paramètres actuels des propriétés du fournisseur. Elle génère ensuite un événement OnGetData.

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, mais utilise UTF8 pour coder les caractères étendus).

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 n'est pas pris en compte si la propriété Options ne contient pas poAllowCommandText.

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.

Les enregistrements sont renvoyés sous la forme d'un paquet de données dans un variant.

Remarque :  Si la propriété DataSet n'est pas définie, InternalGetRecords déclenche une exception.

Voir aussi