GetFieldDescription()

Summary

Gets the description of a field.

 

Syntax

descr = GetFieldDescription(string field_spec)

 

Argument	Contents
field_spec	The field specification

 

Returns

A string describing the field, or null if no description is available.

 

Notes

• This is the description appearing in the balloon help for dataview column headings.

• Not all table types support field descriptions, and for some tables only some of the fields can have a description.

Example

descr = GetFieldDescription("State.Name")

     ShowMessage("State Names have the description: " + descr + ".")

 

Error Codes

Error Type	Meaning
NotFound	The specified view or field was not found
Error	Invalid field specification

 

See Also

Function	Summary
FieldsSupportDescriptions()	Returns an array of fields that support description strings
GetTableStructure()	Gets a list and description of the fields in a table
ModifyTable()	Modifies the file structure of a dBASE, fixed-format text or fixed-format binary table