TDBLookup.GetKeyValue function

Declaration

function GetKeyValue(ValueIndex: Integer): Variant

Arguments

Function result

Value for the Key field retrieved from the lookup dataset.

Description

GetKeyValue is a Variant function used to get a values from an index key field in the linked lookup dataset.

ValueIndex contains the ordinal position in the list of fields defined as key fields in the Field for the linked dataset. When ValueIndex contains a valid position for the list of fields names, the corresponding field value from the lookup dataset is returned. Otherwise, the Null value is used as the return value for the method.

GetKeyField is called from methods in controls which use TDBLookup in their implementation, such as TDBLookupListBox and TDBLookupComboBox.

See also

• TDBLookupListBox
• TDBLookupComboBox
• TDataSet.Fields
• TField.KeyFields
• TField.LookupKeyFields