FireDAC.Comp.Client.TFDAdaptedDataSet.PSGetParams

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function PSGetParams: TParams; override;

C++

virtual Data::Db::TParams* __fastcall PSGetParams();

Properties

Type Visibility Source Unit Parent
function protected
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDAdaptedDataSet

Description

Returns the current parameter values of the dataset.

FireDAC.Comp.Client.TFDAdaptedDataSet.PSGetParams inherits from Data.DB.TDataSet.PSGetParams. All content below this line refers to Data.DB.TDataSet.PSGetParams.

Returns the current parameter values of the dataset.

The provider component calls PSGetParams to implement its GetParams method.

PSGetParams returns a TParams object that describes the current values of all parameters of the dataset. If the dataset does not have any parameters, PSGetParams returns nil (Delphi) or NULL (C++).


This method is an implementation of the IProviderSupport.PSGetParams method and, by default, returns nil for Delphi and NULL for C++, because TDataSet does not implement a provider by default. To use it, every TDataSet descendant must override it in its specific way.

See Also