Arw Delete: Difference between revisions
From MultiCharts
(Created page with "Removes an arrow object with the specified ID number from a chart; returns a value of 0 if the object was successfully removed, and a value of -2 if the specified object ID nu...") |
No edit summary |
||
| Line 1: | Line 1: | ||
Removes an arrow object with the specified ID number from a chart | Removes an arrow object with the specified ID number from a chart. | ||
Arw_Delete returns a value of 0 if the object was successfully removed, and a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight> | <syntaxhighlight> | ||
Arw_Delete(ObjectID) | Arw_Delete(ObjectID) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Where: | |||
An object-specific ID number is | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
== Notes == | |||
* An object-specific ID number is assigned by [[Arw_New]], [[Arw_New_s]], [[Arw_New_self]] or [[Arw_New_self_s]] when the arrow object is created. | |||
== Example == | |||
Remove the arrow object with an ID number of 3: | Remove the arrow object with an ID number of 3: | ||
<syntaxhighlight> | <syntaxhighlight> | ||
Value1=Arw_Delete(3); | Value1 = Arw_Delete(3); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Revision as of 08:05, 19 February 2012
Removes an arrow object with the specified ID number from a chart.
Arw_Delete returns a value of 0 if the object was successfully removed, and a value of -2 if the specified object ID number is invalid.
Usage
Arw_Delete(ObjectID)Where:
- ObjectID - a numerical expression specifying the object ID number.
Notes
- An object-specific ID number is assigned by Arw_New, Arw_New_s, Arw_New_self or Arw_New_self_s when the arrow object is created.
Example
Remove the arrow object with an ID number of 3:
Value1 = Arw_Delete(3);