FieldComment

Returns the specified field's comment.

Format 

FieldComment ( fileName ; fieldName )

Parameters 

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

fieldName - a text expression for the name of a field. The field name must be in the form tablename::fieldname to specify a field that exists in a table different from the current table.

Data type returned 

text

Originated in version 

7.0

Description 

The returned text is the comment entered for the specified field in the Fields tab of the Manage Database dialog (see Defining and changing fields).

Example 1 

FieldComment ( "Customers" ; "Phone Number" ) returns "Customer's home telephone number" if it was entered as a comment for the Phone Number field.

Example 2 

FieldComment ( "Customers" ; "Accounts::Current Balance" ) returns "Customer's current balance" if it was entered as a comment for the Current Balance field in the Accounts table.

Related topics