FireDAC.Comp.Client.TFDCustomMemTable.GetOptionalParam

• Up to Parent: TFDCustomMemTable

[–] Properties Type: function Visibility: public Source:

FireDAC.Comp.Client.pas

FireDAC.Comp.Client.hpp

Unit: FireDAC.Comp.Client Parent: TFDCustomMemTable

Delphi

function GetOptionalParam(const AParamName: string): Variant;

C++

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

Description

Returns an optional custom parameter, associated with a dataset.

Use the GetOptionalParam method to get a custom parameter value, associated with a dataset. 

The parameter value may be set using SetOptionalParam. The optional parameters are part of internal dataset storage and are saved / loaded with dataset at SaveToStream / LoadFromStream calls. FireDAC does not interpret these parameters in any way. 

The method is for the TClientDataSet compatibility.

Example

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));

See Also

• FireDAC.Comp.Client.TFDCustomMemTable.SetOptionalParam