Text SetString

From MultiCharts
Revision as of 14:11, 25 January 2012 by 194.84.116.138 (talk) (Created page with "Replaces with the specified string expression the text contained in a text object with the specified ID number; returns a value of 0 if the string expression was successfully ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Replaces with the specified string expression the text contained in a text object with the specified ID number; returns a value of 0 if the string expression was successfully replaced, and a value of -2 if the specified object ID number is invalid.

Usage

Text_SetString(ObjectID,"Text")

Where: ObjectID - a numerical expression specifying the object ID number

Text - the new string expression to be displayed in the text object

Notes

An object-specific ID number is returned by Text_New when the text object is created.

Example

Replace the text, contained in a text object with the ID number of 3, with the string expression "New Text":

Value1=Text_SetString(3,"New Text");