GetString - inTag Type Description inObject Longint inTag String Function result String handle objectrarr Tag item retrieve rarr The retrieved item larr Discussion OT GetString gets value inObject from 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 value requested element returned If item given tag exists other type OK set zero empty string returned See ldquoThe Character Item Typerdquo page more information storing retrieving strings Warning If result method assigned width String variable itemrsquos contents truncated width variable retrieve more than characters from character item use GetText assign Text variable See OT PutString

OT GetString

View from small screen devices!

OT GetString(inObject; inTag) String

→

Parameter Type Description

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

^→Tag of the item to retrieve ^→The retrieved item ←

Discussion

OT GetString gets a 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 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 Is Character (112), the value of the requested element is returned.

If an item with the given tag exists and has any other type, 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.

Warning 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 item, use OT GetText and assign to a Text variable or ﬁeld.

Topics of Interest
Accessing Embedded Objects
OT PutText
OT PutString
The Character Item Type
OT GetRecordTable
Item Types
OT GetText
Embedded Objects

Published date: Fri, 14 Jul 2006 18:39:05 GMT → View XML Version

Edit this page now