Datasnap.Midas.IAppServerDisp.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; var Params: OleVariant; var OwnerData: OleVariant): OleVariant; dispid 20000001;

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function automated Datasnap.Midas.pas Datasnap.Midas IAppServerDisp

Beschreibung

Gibt ein Datenpaket mit den angegebenen Daten zurück.

Rufen Sie AS_GetRecords auf, 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 BeforeGetRecords-Ereignisbehandlungsroutine 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 abgerufen. Ist Count größer als 0, werden nur die Count-Datensätze abgerufen.

RecsOut gibt die aktuelle Anzahl der abgerufenen Datensätze an.

Options gibt an, welche Informationen zum Datenpaket zusätzlich hinzugefügt 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.

Params ist eine Variante mit allen Parametern, die an die Datenmenge übergeben werden sollen, bevor sie zum Erzeugen der angeforderten Daten ausgeführt wird. Params gibt alle Ausgabeparameter zurück. 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.

OwnerData enthält benutzerdefinierte Daten aus der BeforeGetRecords-Ereignisbehandlungsroutine der Client-Datenmenge. Die Daten werden an die BeforeGetRecords-Ereignisbehandlungsroutine des Providers übergeben. OwnerData gibt die von der AfterGetRecords-Ereignisbehandlungsroutine des Providers bereitgestellten Daten zurück.

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