GetFieldValues()

Summary

Reads the values of one or more fields in any number of views.

Syntax

values_array = GetFieldValues(array field_specs, array options)

Argument Contents
field_specs An array of field specs of fields to read
Option Type Contents
Currency Error Boolean Whether to raise an error if some views do not have current records. Defaults to "False" (i.e., does not raise an error.)

Returns

An array of values read from the input fields, one value per field, or null if field_specs is null.

Notes

  • The type of each value depends on the field being read. Null denotes a missing value for any type of field.

  • The values in the returned array are ordered as the input field_specs array.

  • The fields can be in any number of views; values are read from the current record in each view. This is a principle difference between GetFieldValues() and GetRecordValues().

  • If an input field belongs to a view that has no current record, the field's value is returned as null (and is therefore not distinguishable from a missing value). The Currency Error option can be used to override this default behavior.

Example

flds = {"Employee.LNAME", "Employee.FNAME", "Supervisor.NAME"}
vals = GetFieldValues(flds, null)

Error Codes

Error Type Meaning
Error The input field_specs array contains some non-string values; some of the field specifications are ambiguous; some of the views do not have current records and the Currency Error option is "True"; or file read errors occurred
NotFound Some of the fields do not exist

See Also

Function Summary
GetRecordValues() Reads the values of one or more fields for a record in a view