Soap.SOAPDm.TSoapDataModule.SAS_GetRecords
Delphi
function SAS_GetRecords(const ProviderName: OleStr; Count: Integer; out RecsOut: Integer; Options: Integer; const CommandText: OleStr; var Params: OleVariant; var OwnerData: OleVariant): OleVariant; virtual; stdcall;
C++
virtual System::OleVariant __stdcall SAS_GetRecords(const System::WideString ProviderName, int Count, /* out */ int &RecsOut, int Options, const System::WideString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData);
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
| function | protected | Soap.SOAPDm.pas Soap.SOAPDm.hpp |
Soap.SOAPDm | TSoapDataModule |
Description
Renvoie un paquet de données contenant les données spécifiées.
Appelez SAS_SAS_GetRecords pour obtenir le nombre spécifié d'enregistrements. SAS_SAS_GetRecords renvoie les enregistrements requis, en commençant par l'enregistrement courant de l'ensemble de données du fournisseur. Comme les modules de données SOAP sont sans état, il peut s'avérer 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 BeforeSAS_GetRecords 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 facultative qui remplace le SQL de la requête du fournisseur, ou le nom d'une table ou d'une procédure stockée qui remplace la procédure stockée ou la table de base de données sous-jacente du fournisseur. Ce paramètre n'est pas pris en compte si la propriété Options du fournisseur 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.
OwnerData contient des informations personnalisées qui sont fournies par le gestionnaire d'événement BeforeSAS_GetRecords d'un ensemble de données client. Ces informations sont transmises au gestionnaire d'événement BeforeSAS_GetRecords du fournisseur. OwnerData renvoie les informations fournies par le gestionnaire d'événement AfterSAS_GetRecords du fournisseur.
Les enregistrements sont renvoyés sous la forme d'un paquet de données dans un variant.
Remarque : Les applications ne peuvent appeler la méthode protégée SAS_SAS_GetRecords qu'à l'aide de l'interface IAppServerSOAP. Pour lire les enregistrements directement dans le code à partir du serveur d'applications, utilisez la méthode SAS_GetRecords du composant fournisseur.