Datasnap.Win.TConnect.TLocalConnection.AS_GetRecords
Delphi
function AS_GetRecords(const ProviderName: WideString; Count: Integer; out RecsOut: Integer; Options: Integer; const CommandText: WideString; var Params, OwnerData: OleVariant): OleVariant; safecall;
C++
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.TConnect.pas Datasnap.Win.TConnect.hpp |
Datasnap.Win.TConnect | TLocalConnection |
Beschreibung
Gibt ein Datenpaket zurück, das die angegebenen Daten enthält.
Mit 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 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 abgerufen. 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.
Params
ist eine Variante mit den Parametern, die an die Datenmenge übergeben werden, bevor die angeforderten Daten generiert werden. 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.
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. OwnerData
gibt Daten zurück, die von der Ereignisbehandlungsroutine für AfterGetRecords des Providers bereitgestellt werden.
Die Datensätze werden als Datenpaket in der Variante (als Rückgabewert in Delphi oder als Paramater _result der Methode AS_GetRecords in C++) zurückgegeben.