Parameter Type Description
inObject Longint inTag String inIndex Number Function result Number A handle to an object
→ Tag of the item to retrieve
- Index of array element to retrieve
- The array element’s contents ←
Discussion
OT GetArrayReal gets a value in inObject from the array item referenced by inTag.
If the object is not a valid object handle, an error is generated, OK is set to zero, and zero is returned.
If no item in the object has the given tag, zero is returned. If the FailOnNoItem option is set, an error is generated and OK is set to zero.
If an item with the given tag exists and has the type Real array, and inIndex is in the range (0..OT SizeOfArray(inObject; inTag)), the value of the requested element is returned.
If an item with the given tag exists and has any other type, or if the index is out of range, an error is generated, OK is set to zero, and zero is returned.
See Also