Datasnap.Provider.TCustomProvider.GetParams

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function GetParams(var OwnerData: OleVariant): OleVariant; virtual;

C++

virtual System::OleVariant __fastcall GetParams(System::OleVariant &OwnerData);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
Datasnap.Provider.pas
Datasnap.Provider.hpp
Datasnap.Provider TCustomProvider

Beschreibung

Gibt die aktuellen Parameterwerte zurück.

GetParams liefert ein variantes Array mit varianten Arrays zurück, die die aktuellen Parameterwerte der Datenquelle des Providers enthalten. Die erste Array-Dimension ist ein Index für die Parameterwerte. Der Index enthält Werte von 0 bis Parameteranzahl minus 1. Die zweite Array-Dimension hat vier Werte: den Parameternamen (ein Delphi-String oder ein C++ AnsiString), den Datentyp des Parameters (TFieldType), den Parametertyp (TParamType) und den Parameterwert (eine Variante). Die Werte in diesem Array können mit der globalen Prozedur UnpackParams in das TParams-Objekt eingetragen werden.

Vor dem Abrufen der aktuellen Parameterwerte erzeugt GetParams ein BeforeGetParams-Ereignis und übergibt den Wert des Parameters OwnerData an die Ereignisbehandlungsroutine. Nach der Erzeugung der OleVariante, die die Parameterwerte enthält, generiert GetParams ein AfterGetParams-Ereignis und übergibt den aktuellen Wert von OwnerData. Abschließend wird der von AfterGetParams gelieferte Wert von OwnerData im Parameter OwnerData zurückgegeben.

Siehe auch