Field Management

Macros
#define	DS_FIELDS_NOT_DEFINED
	Value returned by field API functions when a field is not defined. More...

Detailed Description

Any callbacks specified in the initialiser may potentially be called on multiple threads, sometimes concurrently, as a result it is important that the application is thread-safe.

The field management API gives programmatic access to configured fields. A field can be referenced in a number of ways, these functions provide ways to access and map between them.

A field contains:

• index. This is a zero based index for all the fields
• field name. This is a text string
• field number. This is an integer between -65535 and 65535
• flags. Flags associated with this field

The index is useful for storing or keeping track of fields in an application. It is also the fastest lookup method to access the other attributes and allows you to loop through all the fields if required.

Macro Definition Documentation

#define DS_FIELDS_NOT_DEFINED

Value returned by field API functions when a field is not defined.