Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS_GetRecords

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche


Delphi

function  AS_GetRecords(const ProviderName: OleStr; Count: Integer;  out RecsOut: Integer; Options: Integer; const CommandText: OleStr; ParamReader: TDBXStreamValue; OwnerDataStream: TDBXStreamValue): OleVariant;

C++

System::OleVariant __fastcall AS_GetRecords(const System::WideString ProviderName, int Count, /* out */ int &RecsOut, int Options, const System::WideString CommandText, Data::Dbxcommon::TDBXStreamValue* ParamReader, Data::Dbxcommon::TDBXStreamValue* OwnerDataStream);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
Datasnap.DSProviderDataModuleAdapter.pas
Datasnap.DSProviderDataModuleAdapter.hpp
Datasnap.DSProviderDataModuleAdapter TDSProviderDataModuleAdapter

Beschreibung

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

Rufen Sie AS_GetRecords , um eine bestimmte Anzahl von Datensätzen abzurufen. AS_GetRecords gibt die angeforderten Datensätze ab dem aktuellen Datensatz in der Datenmenge des Providers zurück. Wenn Sie mit statuslosen externen Datenmodulen arbeiten, müssen Sie möglicherweise in der Ereignisbehandlungsroutine für BeforeGetRecords des Providers den Cursor neu positionieren oder die Abfrage bzw. Stored Procedure neu ausführen.

ProviderName ist der Name der Provider-Komponente, die die Datensätze bereitstellt.

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 als 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. Der folgende Wert fordert beispielsweise Metadaten zusammen mit einem XML-Datenpaket an:



MetaDataOption + XMLOption



MetaDataOption || XMLOption



CommandText gibt entweder eine optionale SQL-Anweisung, die die SQL-Anweisung einer Abfrage ersetzt, oder den Namen einer Tabelle oder Stored Procedure an, die die Tabelle oder Stored Procedure des Providers ersetzt. Wenn poAllowCommandText in Options nicht enthalten ist, wird dieser Parameter ignoriert.

ParamReader ist eine Variante mit den Parametern, die an die Datenmenge des Providers übergeben werden, bevor die angeforderten Daten generiert werden. In ParamReader werden auch die Ausgabeparameter zurückgegeben. Das Variantenformat für die in diesem Argument und die mit einem TParams-Objekt verwendeten Parameter kann mit den globalen Routinen PackageParams und UnpackParams konvertiert werden.

Der Parameter OwnerDataStream 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 OwnerDataStream zurückgegeben wird, wird an die Ereignisbehandlungsroutine für AfterGetRecords der Client-Datenmenge übergeben.

Datensätze werden als Datenpaket in einer Variante zurückgegeben (entweder als Rückgabewert in Delphi oder als Parameter AS_GetRecords _result in C++).

Siehe auch