LCFieldlist Class Methods Summary

The LCFieldlist class method is summarized here.

Creation

The following methods create and free fieldlist instances. The fieldlist merging methods also create new fieldlists.

Method

Description

New LCFieldlist

Constructor. Creates a new fieldlist object instance.

LCFieldlist.Copy

Creates a new fieldlist object instance as a copy of another fieldlist. The field data is also copied.

LCFieldlist.CopyRef

Creates a new fieldlist object instance as a partial copy of another fieldlist. The contained fields are not copied, but are rather referenced.

Delete LCFieldlist

Destructor. Frees a fieldlist object instance created with the constructor, LCFieldlist.Copy, LCFieldlist.CopyRef, LCFieldlist.Merge, or LCFieldlist.MergeVirtual.

Fieldlist Retrieval

The following methods support retrieval of fieldlist contents.

Method

Description

LCFieldlist.GetField

Retrieves a particular field from a fieldlist by field index.

LCFieldlist.GetName

Retrieves a copy of a field name from a fieldlist by field index.

LCFieldlist.Lookup

Locates a field in a fieldlist by field name.

LCfieldlist.List

Iterates through fields in a fieldlist.

Fieldlist Modification

The following methods support modification of fieldlist contents.

Method

Description

LCFieldlist.Append

Adds a new field to the end of a fieldlist.

LCFieldlist.Insert

Inserts a new field into a fieldlist.

LCFieldlist.Remove

Removes a field from a fieldlist.

LCFieldlist.Replace

Replaces a field in a fieldlist with a new field.

LCFieldlist.Copyfield

Copies an existing field into a fieldlist.

LCFieldlist.Includefield

Embeds an existing field into a fieldlist.

LCFieldlist.SetName

Renames a field within a fieldlist.

Fieldlist Merging

The following methods support fieldlist merging.

Method

Description

LCFieldlist.Merge

Merges a name fieldlist and data fieldlist to produce a mapped fieldlist.

LCFieldlist.MergeVirtual

Merges a name fieldlist and data fieldlist to produce a mapped fieldlist. Fields with matching virtual codes are added to a new virtual fieldlist.

Fieldlist Mapping

The following methods support fieldlist mapping.

Method

Description

LCFieldlist.Map

Maps fields with the same names but changes the positions and can exclude some fields.

LCFieldlist.MapName

Maps fields with different names.

LCFieldlist Properties Summary

The following is a list of fieldlist properties.

Property

Description

LCFieldlist.GetCount

Retrieves the current number of fields in a fieldlist.

LCFieldlist.GetRecordCount

Retrieves the record count supplied when allocating a fieldlist.

LCFieldlist.GetSequence

Retrieves the current sequence number for a fieldlist.

All other properties are dynamic. Field data may be accessed by referencing the field name.