FireDAC.Comp.Client.TFDCustomMemTable.GetOptionalParam

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function GetOptionalParam(const AParamName: string): Variant;

C++

System::Variant __fastcall GetOptionalParam(const System::UnicodeString AParamName);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomMemTable


Beschreibung

Gibt einen optionalen benutzerdefinierten Parameter zurück, der einer Datenmenge zugeordnet ist.

Mit der Methode GetOptionalParam wird der Wert eines benutzerdefinierten Parameters abgerufen, der einer Datenmenge zugeordnet ist. 

Der Wert des Parameters kann mit SetOptionalParam gesetzt werden. Die optionalen Parameter sind Bestandteil des internen Speichers der Datenmenge und werden durch die Aufrufe SaveToStream / LoadFromStream gespeichert bzw. mit der Datenmenge geladen. FireDAC interpretiert diese Parameter in keiner Weise. 

Die Methode dient der TClientDataSet-Kompatibilität.

Beispiel

 var
 dt: Variant;
 ...
 dt := FDMemTable1.GetOptionalParam('last_modified_date');
 if VarIsNull(dt) then
 ShowMessage('No modifications were done')
 else
 ShowMessage('Last modification was done at ' + DateToStr(dt));

Siehe auch