Difference between revisions of "Arw GetVal"
Jump to navigation
Jump to search
(→Usage) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | Returns the price value (vertical position, corresponding to a value on the price scale of a chart), at which an arrow object with the specified ID number has been placed | + | Returns the price value (vertical position, corresponding to a value on the price scale of a chart), at which an arrow object with the specified ID number has been placed. |
| + | |||
| + | Arw_GetVal returns a value of -2 if the specified object ID number is invalid. | ||
| − | + | == Usage == | |
| + | <syntaxhighlight>Arw_GetVal(ObjectID)</syntaxhighlight> | ||
| − | + | 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 value, indicating the price value at which an arow object with the ID number of 3 has been placed, to the Value1 variable: | ||
| + | <syntaxhighlight>Value1 = Arw_GetVal(3);</syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 08:43, 19 February 2012
Returns the price value (vertical position, corresponding to a value on the price scale of a chart), at which an arrow object with the specified ID number has been placed.
Arw_GetVal returns a value of -2 if the specified object ID number is invalid.
Usage
Arw_GetVal(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 value, indicating the price value at which an arow object with the ID number of 3 has been placed, to the Value1 variable:
Value1 = Arw_GetVal(3);
