FireDAC.Comp.Client.TFDCustomMemTable.SetOptionalParam

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure SetOptionalParam(const AParamName: string; const AValue: Variant;
AIncludeInDelta: Boolean = False); virtual;

C++

virtual void __fastcall SetOptionalParam(const System::UnicodeString AParamName, const System::Variant &AValue, bool AIncludeInDelta = false);

Properties

Type Visibility Source Unit Parent
procedure
function
public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomMemTable

Description

Sets an optional custom parameter, associated with a dataset.

Use SetOptionalParam method to set a custom parameter value, associated with dataset. 

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

The method is for the TClientDataSet compatibility.

See Also