Skip to content

IndexFromObject - cCollection

Returns the index for the object-handle, ho, in the collection

Type: Function
Return Data Type: Integer

Parameters

Parameter Type Description
ho Handle The object handle

Syntax

Function IndexFromObject Handle ho Returns Integer

Call Example

Get IndexFromObject ho to IntegerVariable

Description

IndexFromObject returns the index for the object-handle, ho, in the collection. The index is zero-based, which means that the first object-handle in the collection would return zero as its index. If the object-handle is not in the collection, the function returns a value of -1.

Return Value

The first object-handle in the collection would return zero as its index. If the object-handle is not in the collection, the function returns a value of -1.