Arw GetStyle: Difference between revisions
From MultiCharts
no edit summary
(→Notes) |
No edit summary |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
Returns a numerical value, indicating the style of the arrow in an arrow object with the specified ID number | Returns a numerical value, indicating the style of the arrow in an arrow object with the specified ID number. | ||
Arw_GetStyle returns a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Arw_GetStyle(ObjectID)</syntaxhighlight> | <syntaxhighlight>Arw_GetStyle(ObjectID)</syntaxhighlight> | ||
Where: ObjectID - a numerical expression specifying the object ID number | Where: | ||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
== 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 a value, indicating the style of the arrow in an arrow object with the ID number of 3, to Value1 variable: | Assign a value, indicating the style of the arrow in an arrow object with the ID number of 3, to Value1 variable: | ||
<syntaxhighlight>Value1=Arw_GetStyle(3);</syntaxhighlight> | <syntaxhighlight>Value1 = Arw_GetStyle(3);</syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] |