Difference between revisions of "Text SetString"
Jump to navigation
Jump to search
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 13: | Line 13: | ||
== Notes == | == Notes == | ||
| − | An object-specific ID number is returned by [[Text_New]] when the text object is created. | + | * An object-specific ID number is returned by [[Text_New]] when the text object is created. |
| − | + | * Use [[Text_GetString]] to get the string expression from a specified text object. | |
| + | |||
== Example == | == Example == | ||
Replace the text, contained in a text object with the ID number of 3, with the string expression "New Text": | Replace the text, contained in a text object with the ID number of 3, with the string expression "New Text": | ||
Latest revision as of 12:34, 13 February 2012
Replaces with the specified string expression the text contained in a text object with the specified ID number.
Text_SetString 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.
- Use Text_GetString to get the string expression from a specified text object.
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");
