Datasnap.Win.MtsRdm.TMtsDataModule.AS_GetRecords

Übergeordnet: TMtsDataModule

Delphi

function AS_GetRecords(const ProviderName: WideString; Count: Integer;  out RecsOut: Integer; Options: Integer; const CommandText: WideString; var Params, OwnerData: OleVariant): OleVariant; safecall;

C++

HIDESBASE 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);

Eigenschaften

Typ	Sichtbarkeit	Quelle	Unit	Übergeordnet
function	protected	Datasnap.Win.MtsRdm.pas Datasnap.Win.MtsRdm.hpp	Datasnap.Win.MtsRdm	TMtsDataModule

Beschreibung

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

Datasnap.Win.MtsRdm.TMtsDataModule.AS GetRecords erbt von Datasnap.DataBkr.TRemoteDataModule.AS_GetRecords. Der folgende Inhalt bezieht sich auf Datasnap.DataBkr.TRemoteDataModule.AS_GetRecords.

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

Mit AS_AS_GetRecords können Sie eine bestimmte Anzahl von Datensätzen abrufen. Die Methode 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 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 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 der Variante (Parameter) AS_GetRecords_result (C++) zurückgegeben.

Anmerkung: Anwendungen können die als protected deklarierte Methode AS_GetRecords nur über das TRemoteDataModule-Interface aufrufen. Um Datensätze direkt abzurufen, verwenden Sie die Methode AS_GetRecords der Provider-Komponente.