GetArrayString - Parameter Type Description inObject Longint inTag String inIndex Number Function result String handle objectrarr Tag item retrieve Index array element retrieveThe array elementrsquos contents larr Discussion OT GetArrayString gets value inObject from array item referenced inTag If object not valid object handle error generated OK set zero empty string returned If item object given tag empty string returned FailOnNoItem option set error generated OK set zero If item given tag exists type OT Character array inIndex range 0OT inTag value requested element returned If item given tag exists other type index out range error generated OK set zero empty string returned See ldquoThe Character Item Typerdquo page more information storing retrieving strings Note If result method assigned width String variable itemrsquos contents truncated width variable retrieve more than characters from Character Array use GetArrayText assign Text variable See OT PutArray

OT GetArrayString

View from small screen devices!

Parameter Type Description

inObject Longint inTag String inIndex Number Function result String A handle to an object

^→Tag of the item to retrieve

Index of array element to retrieve
The array element’s contents ←

Discussion

OT GetArrayString 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 an empty string is returned.

If no item in the object has the given tag, an empty string 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 OT Character 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 an empty string is returned.

See “The Character Item Type” on page 11 for more information on storing and retrieving strings.

Note If the result of this method is assigned to a ﬁxed width String variable, the item’s contents will be truncated to the width of the variable. To retrieve more than 255 characters from a Character Array, use OT GetArrayText and assign to a Text variable or ﬁeld.

See Also

OT PutArray , OT GetArrayText

Topics of Interest
Accessing Array Elements within Object I...
OT GetString
OT PutArrayString
OT GetArrayText
Using Arrays with Objects
The Character Item Type
Item Types

Published date: Sat, 15 Jul 2006 21:34:04 GMT → View XML Version

Edit this page now