Arw GetDirection: Difference between revisions
From MultiCharts
(→Usage) |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
Returns a logical value indicating the direction of the arrow contained in an arrow object with the specified ID number | Returns a logical value indicating the direction of the arrow contained in an arrow object with the specified ID number. | ||
Arw_GetDirection returns a value of [[True]] for Down arrow, and a value of [[False]] for Up arrow or if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Arw_GetDirection(ObjectID)</syntaxhighlight> | |||
Where: | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
An object-specific ID number is | |||
== 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 a true/false value, indicating the direction of the arrow contained in an arrow object with the ID number of 3, to DownArrow variable: | Assign a true/false value, indicating the direction of the arrow contained in an arrow object with the ID number of 3, to DownArrow variable: | ||
<syntaxhighlight>Variable:DownArrow(False); | <syntaxhighlight>Variable: DownArrow(False); | ||
DownArrow=Arw_GetDirection(3);</syntaxhighlight> | |||
DownArrow = Arw_GetDirection(3);</syntaxhighlight> | |||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 08:23, 19 February 2012
Returns a logical value indicating the direction of the arrow contained in an arrow object with the specified ID number.
Arw_GetDirection returns a value of True for Down arrow, and a value of False for Up arrow or if the specified object ID number is invalid.
Usage
Arw_GetDirection(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.
- Use Arw_GetActive, Arw_GetFirst or Arw_GetNext to get the object-specific ID number of an already created arrow.
Example
Assign a true/false value, indicating the direction of the arrow contained in an arrow object with the ID number of 3, to DownArrow variable:
Variable: DownArrow(False);
DownArrow = Arw_GetDirection(3);