Get Index of Key

Use this system function to get the zero-based index position of an item in a combo box list by specifying its key. If the key value specified does not exist in the combo box's current set of items, no index value is returned and an error message is logged.

Parameters

Grid Control

Input, required. The grid FC to affect.

Grid Column

Input, required. The grid column to affect. Set the parameter to an applicable object from the object list.

Grid Row

Input, required. The grid row to affect (integer). Set the parameter to an alphanumeric constant (<Literal>), <Currently Selected Row>, or an applicable object from the object list.

Key

Input, required. The key of the target item (string or math-numeric). Set the parameter to an alphanumeric constant (<Literal>) or applicable object from the object list.

Index

Input, required. The object to which to assign the return value that designates the zero-based index position of the target item (integer). Set the parameter to an alphanumeric constant (<Literal>) or applicable object from the object list.

Returns

This system function returns the zero-based index position of a combo box item to the object identified by Index.