Data.SqlExpr.TCustomSQLDataSet.PSGetParams

From RAD Studio API Documentation

Delphi

function PSGetParams: TParams; override;

C++

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

Properties

Type Visibility Source Unit Parent
function protected
Data.SqlExpr.pas
Data.SqlExpr.hpp
Data.SqlExpr TCustomSQLDataSet

Description

Returns the current parameter values of the dataset. {{#multireplace:Data.SqlExpr.TCustomSQLDataSet.PSGetParams|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}} inherits from {{#multireplace:Data.DB.TDataSet.PSGetParams|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}}. All content below this line refers to {{#multireplace:Data.DB.TDataSet.PSGetParams|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}}.

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