FieldsSupportDescriptions()

Summary

Returns a list of fields that can have a description string.

Syntax

desc = FieldsSupportDescriptions(string view, array fields, array options)

No options are currently supported.

Returns

An array of fields that allow their description string to be set.

Notes

• The array of fields can be null if all fields are to be considered.

• If the input fields array is not null, the return array is a sub-array of the input, i.e., it uses the same order and field specification as the input.

Example

// Change the description for the Population field.
table = GetTableStructure("State") // Get all the settings of the table
aggr = FieldsSupportDescriptions("State", {"White", "Black", "Population"}, )
if ArrayPosition(aggr, {"Population"}, ) <> 0 then do
// We can set description string for "Population"
for i = 1 to table.length do
if table[i][1] = "Population" then
// Set the new aggregation rules:
table[i][8] = "The state's population, according to the 1990 census."
// For ModifyTable: add the original field name
table[i] = table[i] + {table[i][1]}
end
ModifyTable("State", table)
end
else
ShowMessage("Cannot set the description for the Population field.")

Error Codes

See Also