Soap.SOAPDm.TSoapDataModule.SAS_GetRecords

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche


Delphi

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

C++

virtual System::OleVariant __stdcall SAS_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.

Mit SAS_SAS_GetRecords können Sie eine bestimmte Anzahl von Datensätzen abrufen. Die Methode SAS_SAS_GetRecords gibt die angeforderten Datensätze ab dem aktuellen Datensatz in der Datenmenge des Providers zurück. Da SOAP-Datenmodule keinen Status haben, müssen Sie möglicherweise in der Ereignisbehandlungsroutine für BeforeSAS_GetRecords des Providers den Cursor neu positionieren oder die Abfrage bzw. Stored Procedure neu ausführen.

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. 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 BeforeSAS_GetRecords der Client-Datenmenge. Die Daten werden an die Ereignisbehandlungsroutine für BeforeSAS_GetRecords des Providers übergeben. Der Wert, der in OwnerData zurückgegeben wird, wird an die Ereignisbehandlungsroutine für AfterSAS_GetRecords der Client-Datenmenge übergeben.

Die Datensätze werden als Datenpaket in einer Variante zurückgegeben.

Anmerkung:  Die als protected deklarierte Methode SAS_SAS_GetRecords kann nur über die Schnittstelle IAppServerSOAP aufgerufen werden. Um Datensätze direkt abzurufen, verwenden Sie die Methode SAS_GetRecords der Provider-Komponente.

Siehe auch