GetArrayLong - Parameter Type Description inObject Longint inTag String inIndex Number Function result Number handle objectrarr Tag item retrieve Index array element retrieveThe array elementrsquos contents larr Discussion OT GetArrayLong gets value inObject from array item referenced inTag If object not valid object handle error generated OK set zero zero returned If item object given tag zero returned FailOnNoItem option set error generated OK set zero If item given tag exists type Longint array inIndex range 0OT inTag value requested element returned If item given tag exists other type index out range error generated OK set zero zero returned See OT PutArray GetLongOT inTag inIndex Picture

OT GetArrayLong

View from small screen devices!

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 GetArrayLong 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 Longint 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.

Topics of Interest
Ot PutArrayLong
OT GetLong
Put Value Routines
Get Value Routines

Published date: Sat, 15 Jul 2006 21:26:52 GMT → View XML Version

Edit this page now