Arw SetSize: Difference between revisions
From MultiCharts
(Created page with "Assigns the specified size to the arrow contained in an arrow object with the specified ID number; returns a value of 0 if the size was successfully assigned, and a value of -...") |
No edit summary |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Assigns the specified size to the arrow contained in an arrow object with the specified ID number | Assigns the specified size to the arrow contained in an arrow object with the specified ID number. | ||
Arw_SetSize returns a value of 0 if the size was successfully assigned, and a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Arw_SetSize(ObjectID,ArrowSize)</syntaxhighlight> | <syntaxhighlight>Arw_SetSize(ObjectID, ArrowSize)</syntaxhighlight> | ||
Where: | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
:'''ArrowSize''' - a numerical expression specifying the arrow size. | |||
== Notes == | |||
An object-specific ID number is | * 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. | ||
* Use [[Arw_GetActive]], [[Arw_GetFirst]] or [[Arw_GetNext]] to get the object-specific ID number of an already created arrow. | |||
== Example == | |||
Assign an arrow size of 10 to the arrow object with an ID number of 3: | Assign an arrow size of 10 to the arrow object with an ID number of 3: | ||
<syntaxhighlight>Value1=Arw_SetSize(3,10);</syntaxhighlight> | <syntaxhighlight>Value1 = Arw_SetSize(3, 10);</syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 09:09, 19 February 2012
Assigns the specified size to the arrow contained in an arrow object with the specified ID number.
Arw_SetSize returns a value of 0 if the size was successfully assigned, and a value of -2 if the specified object ID number is invalid.
Usage
Arw_SetSize(ObjectID, ArrowSize)Where:
- ObjectID - a numerical expression specifying the object ID number.
- ArrowSize - a numerical expression specifying the arrow size.
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.
- Use Arw_GetActive, Arw_GetFirst or Arw_GetNext to get the object-specific ID number of an already created arrow.
Example
Assign an arrow size of 10 to the arrow object with an ID number of 3:
Value1 = Arw_SetSize(3, 10);