FieldAnnotation

Returns the specified field's annotation used in Data Definition Language (DDL).

Format 

FieldAnnotation ( 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 

26.0

Description 

The returned text is the annotation entered for the specified field in the Advanced Options for Field dialog (see Defining advanced field options).

Example 1 

FieldAnnotation ( "" ; "Phone Number" ) returns the annotation for the Phone Number field in the current table in the current file, which is Customer's home telephone number.

Example 2 

FieldAnnotation ( "Customers" ; "Accounts::Current Balance" ) returns the annotation for the Current Balance field in the Accounts table in the open file named Customers, which is Customer's current balance.

Related topics