Data.SqlExpr.TCustomSQLDataSet.PSGetTableName

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function PSGetTableName: string; override;

C++

virtual System::UnicodeString __fastcall PSGetTableName(void);

Properties

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

Description

Returns the name of the dataset table that appears in generated SQL statements.

Data.SqlExpr.TCustomSQLDataSet.PSGetTableName inherits from Data.DB.TDataSet.PSGetTableName. All content below this line refers to Data.DB.TDataSet.PSGetTableName.

Returns the name of the dataset table that appears in generated SQL statements.

PSGetTableName returns the name of the underlying database table against which updates are applied when the provider's ResolveToDataSet property is False. This value is used for generating the SQL statements that apply updates. The generated SQL statements are subsequently executed by a call to PSExecuteStatement.

If PSGetTableName does not return a table name, the provider must have an OnGetTableName event handler to supply this value.

This method is an implementation of IProviderSupport.PSGetTableName and, by default, returns an empty string. To use it, every TDataSet descendant must override it in its specific way.

See Also