GetArray - OT Type Description inObject Longint inTag String outArray Array handle objectrarr Tag item set rarr Array receive itemrsquos contents larr Discussion OT GetArray gets array value inObject from item referenced inTag If object not valid object handle error generated OK set zero outArray cleared If item object given tag outArray cleared FailOnNoItem option set error generated OK set zero If item given tag exists compatible type arrayrsquos contents replaced If item given tag exists other type error generated OK set zero array cleared Array Type Compatibility Except String Text arrays put get arrays same type array variable String Text arrays however mixed matched because ObjectTools stores both types array item type OT Character array Note If retrieve width String Array elements tnuncated width array See AlsoOT PutArray

OT GetArray

View from small screen devices!

OT GetArray

Parameter Type Description

inObject Longint inTag String outArray Array A handle to an object

^→Tag of the item to set ^→Array to receive the item’s contents ←

Discussion

OT GetArray gets an array value in inObject from the item referenced by inTag.

If the object is not a valid object handle, an error is generated, OK is set to zero, and outArray is cleared.

If no item in the object has the given tag, outArray is cleared. 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 a compatible type, the array’s contents are replaced.

If an item with the given tag exists and has any other type, an error is generated, OK is set to zero, and array is cleared.

Array Type Compatibility

Except for String and Text arrays, you must put and get arrays into the same type of array variable. String and Text arrays, however, may be mixed and matched, because ObjectTools stores both types of array with an item type of OT Character array (113).

Note If you retrieve into a ﬁxed width String Array, the elements will be tnuncated to the width of the array.

See Also

OT PutArray, OT GetArrayBoolean (inObject; inTag; inIndex) Number

Published date: Sat, 15 Jul 2006 21:20:14 GMT → View XML Version

Edit this page now