Soap.SOAPDm.TSoapDataModule.GetRecords

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function  GetRecords(const ProviderName: OleStr; Count: Integer; out RecsOut: Integer;  Options: Integer; const CommandText: OleStr; var Params: OleVariant; var OwnerData: OleVariant): OleVariant;

C++

System::OleVariant __fastcall GetRecords(const System::WideString ProviderName, int Count, /* out */ int &RecsOut, int Options, const System::WideString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function protected
Soap.SOAPDm.pas
Soap.SOAPDm.hpp
Soap.SOAPDm TSoapDataModule

Beschreibung

Gibt ein Datenpaket mit den gewünschten Daten zurück.

GetRecords stellt die Implementierungen der Methoden AS_GetRecords (auf der IAppServer-Schnittstelle) und SAS_GetRecords (auf der IAppServerSoap-Schnittstelle) bereit. Die Methode GetRecords gibt die angeforderten Datensätze ab dem aktuellen Datensatz in der Datenmenge des Providers zurück.

  • ProviderName gibt die Provider-Komponente an, von der die Datensätze abgerufen werden sollen.
  • Count ist die Anzahl oder der Typ der Datensätze, die abgerufen werden sollen. Wenn Count -1 ist, werden alle Datensätze abgerufen. Hat Count den Wert 0, werden nur die Metadaten gelesen. Ist Count größer 0, werden Count Datensätze abgerufen.
  • RecsOut gibt die Anzahl der tatsächlich abgerufenen Datensätze an.
  • Options gibt an, welche Informationen zusätzlich zum Datenpaket abgerufen werden sollen. Der Parameter enthält eine Kombination der GetRecordOption-Konstanten.
  • CommandText ist eine optionale SQL-Anweisung, die die SQL-Anweisung des Providers ersetzt, oder der Name einer Stored Procedure, die die Stored Procedure des Providers ersetzt. Der Parameter wird ignoriert, wenn die Eigenschaft Options nicht das Flag poAllowCommandText enthält.
  • Params ist eine Variante mit den Parametern, die an die Datenmenge übergeben werden, bevor die angeforderten Daten generiert werden. In Params werden auch die Ausgabeparameter zurückgegeben.
  • Der Parameter OwnerData enthält benutzerdefinierte Daten aus der Ereignisbehandlungsroutine für BeforeGetRecords der Client-Datenmenge. Die Daten werden an die Ereignisbehandlungsroutine für BeforeGetRecords des Providers übergeben. Der Wert, der in OwnerData zurückgegeben wird, wird an die Ereignisbehandlungsroutine für AfterGetRecords der Client-Datenmenge übergeben.
  • Die Datensätze werden als Datenpaket in einer Variante zurückgegeben.

Siehe auch