SetIndex

Sets the record-set offset to map the value of a long text to the value of a short text.

Syntax

Function SetIndex(lIndex As Long) As Long

Parameters

lIndex

Required [in]; Specifies the index (position) at which the combo engine should first try mapping the long text to the short text in the associated record-set. The index is the index of the element selected in the list box of the combo control.

Return Values

Returns the previous index value that was set.

Remarks

It sets the index, which is used by the MapLongToShort method. The index is a zero-based record-set. Using the index, MapLongToShort searches for the long text at this offset in the record-set. If the long text value at that offset is not the one required, MapLongToShort performs a linear search through each item in the record-set. If a match is found, the corresponding short text is returned, otherwise an empty short text is returned.

 

This function is used only in the context of mapping long to short text values when there are duplicate long text values.