ars_GetField(ctrl,schema,id)
Returns a hash reference to information about a field. The hash
will contain the following elements:
- fieldId
-
the field id of the field
- createMode
-
will be one of: open, protected
- option
-
- dataType
-
will be one of: keyword, integer, real, char, diary, enum,
time, or bitmask.
- defaultVal
-
- limit
-
this is a hash. it's keys are (depending upon the dataType):
- min, max, precision
-
used the integer and real types (precision is only for
reals).
- maxLength
-
used for char type.
- menuStyle
-
will be either append or overwrite
- match
-
will be one of: anywhere, leading or equal
- charMenu
-
contains the name of the menu attached to this field.
- pattern
-
contains the pattern to match the field against.
- fullTextOptions
-
will be one either none or indexed
- displayList
-
- helpText
-
- timestamp
-
- owner
-
- lastChanged
-
- changeDiary
-
- On success
-
a hash
- On failure
-
undef
Example:
Back to Table of Contents