API:FireDAC.Comp.DataSet.TFDDataSet.PSGetKeyFields

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function PSGetKeyFields: string; override;

C++

virtual System::UnicodeString __fastcall PSGetKeyFields();

Properties

Type Visibility Source Unit Parent
function protected
FireDAC.Comp.DataSet.pas
FireDAC.Comp.DataSet.hpp
FireDAC.Comp.DataSet TFDDataSet

Description

Returns the names of all fields required to uniquely identify records in the data packet.

FireDAC.Comp.DataSet.TFDDataSet.PSGetKeyFields inherits from Data.DB.TDataSet.PSGetKeyFields. All content below this line refers to Data.DB.TDataSet.PSGetKeyFields.

Returns the names of all fields required to uniquely identify records in the data packet.

The provider component calls PSGetKeyFields to determine what information is required to uniquely identify records in the data packet. This information allows it to locate the records that need to change when it applies updates.

PSGetKeyFields returns a semicolon-delimited string that lists the names of the key fields of the dataset. By default (as implemented by TDataSet), these are the fields with pfInKey included in their ProviderFlags property.

This method is an implementation of IProviderSupport.PSGetKeyFields.


See Also