BaseTableComment

Returns the specified base table's comment.

Format 

BaseTableComment ( fileName ; baseTableName )

Parameters 

fileName - the name of an open database file (local or remote). See Design functions.

baseTableName - a text expression for the name of a base table.

Data type returned 

text

Originated in version 

26.0

Description 

The returned text is the comment entered for the specified base (or source) table in the Tables tab of the Manage Database dialog (see Defining database tables).

Example 1 

BaseTableComment ( "" ; "Contacts" ) returns the comment for the Contacts base table in the current file, which is Contacts at companies stored in the Customers table.

Example 2 

BaseTableComment ( "Invoice System" ; "Orders" ) returns the comment for the Orders base table in the open file named Invoice System, which is Orders for items in the Line Items table.

Related topics