Data.DB.IProviderSupport.PSGetKeyFields

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function PSGetKeyFields: string;

C++

virtual System::UnicodeString __fastcall PSGetKeyFields _DEPRECATED_ATTRIBUTE0 (void) = 0 ;

Properties

Type Visibility Source Unit Parent
function public
Data.DB.pas
Data.DB.hpp
Data.DB IProviderSupport

Description

Warning: PSGetKeyFields is deprecated. Please use IProviderSupportNG.

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.

See Also