Datasnap.Win.TConnect.TLocalConnection.AS_GetRecords
Delphi
function AS_GetRecords(const ProviderName: WideString; Count: Integer;
out RecsOut: Integer; Options: Integer; const CommandText: WideString;
var Params, OwnerData: OleVariant): OleVariant; safecall;
C++
HRESULT __safecall AS_GetRecords(const System::WideString ProviderName, int Count, /* out */ int &RecsOut, int Options, const System::WideString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData, System::OleVariant &__AS_GetRecords_result);
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | protected | Datasnap.Win.TConnect.pas Datasnap.Win.TConnect.hpp |
Datasnap.Win.TConnect | TLocalConnection |
Description
Renvoie un paquet de données contenant les données spécifiées.
Appelez AS_GetRecords pour obtenir le nombre spécifié d'enregistrements. AS_GetRecords renvoie les enregistrements requis, en commençant par l'enregistrement courant de l'ensemble de données du fournisseur. Si vous travaillez avec un module de données distant sans état, il peut être nécessaire de repositionner le curseur ou de réexécuter une requête ou une procédure stockée dans le gestionnaire d'événement BeforeGetRecords du fournisseur.
ProviderName spécifie le nom du composant fournisseur qui fournit les enregistrements.
Count indique le nombre ou le type d'enregistrements à récupérer. 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 supérieur à 0, Count enregistrements sont récupérés.
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. 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 optionnelle qui remplace le SQL d'une requête ou le nom d'une table ou procédure stockée qui remplace la table ou la procédure stockée du fournisseur. Ce paramètre n'est pas pris en compte si la propriété Options ne contient pas poAllowCommandText.
Params est un Variant contenant tous les paramètres qui doivent être transmis à l'ensemble de données du fournisseur avant qu'il exécute pour générer les données demandées. Il renvoie tous les paramètres en sortie. Vous pouvez effectuer une conversion entre le format Variant des paramètres utilisés par cet argument et un objet TParams à l'aide des routines globales PackageParams et UnpackParams.
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. OwnerData renvoie les informations fournies 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, (en tant que valeur renvoyée dans Delphi ou le paramètre AS_GetRecords_result dans C++).