of_locateItem

Description

Converts an item name into an item position.

Syntax

of_locateItem(String item)

of_locateItem(String group, String item)

Parameter(s)

Name Type Description
group String The name of the group containing the item for which the item index is to be returned. The text of the group is the text the programmer gave when of_addGroup was called or when of_setText was last called for the item. This parameter is optional.
item String The name of the item for which the item index is to be returned. The text of the item is the text the programmer gave when of_addGroup, of_addLabel or of_addLink was called or when of_setText was last called for the item. The index of the item is the same as the value returned when of_addGroup, of_addLabel or of_addLink was called.

Return Value

Returns a long that contains the item index for the item requested. It returns a NULL of there is an error or the item name is not found. The index can be a point to a group or an item within a group.

Usage

When the group parameter is included, the item parameter should only contain a label or link reference. When the group parameter is excluded, the item parameter can reference a group, label or link.

Examples

Long                     ll_item
ll_item                  = of_locateItem('Open')

See Also

Last edited Oct 17, 2016 at 1:05 PM by cjharris02892, version 4