Arw SetLocation s: Difference between revisions
From MultiCharts
(→Notes) |
No edit summary |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
Modifies the location of an arrow object with the specified ID number | Modifies the location of an arrow object with the specified ID number. | ||
Arw_SetLocation_s returns a value of 0 if the location of the object was successfully modified, and a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Arw_SetLocation_s (ObjectID, BarDate, BarTime_s, PriceValue)</syntaxhighlight> | <syntaxhighlight>Arw_SetLocation_s(ObjectID, BarDate, BarTime_s, PriceValue)</syntaxhighlight> | ||
== Parameters == | |||
ObjectID - a numerical expression specifying the object ID number | :'''ObjectID''' - a numerical expression specifying the object ID number. | ||
BarDate - a numerical expression specifying the date of the bar at which the object is to be placed; the date is indicated in the YYYMMdd format, where YYY is the number of years since 1900, MM is the month, and dd is the day of the month | :'''BarDate''' - a numerical expression specifying the date of the bar at which the object is to be placed; the date is indicated in the ''YYYMMdd'' format, where YYY is the number of years since 1900, MM is the month, and dd is the day of the month. | ||
BarTime_s - a numerical expression specifying the time of the bar, including seconds, at which the object is to be placed; the time is indicated in the 24-hour HHmmss format, where 130000 = 1:00:00 PM | :'''BarTime_s''' - a numerical expression specifying the time of the bar, including seconds, at which the object is to be placed; the time is indicated in the 24-hour ''HHmmss'' format, where 130000 = 1:00:00 PM. | ||
PriceValue - a numerical expression specifying the price value (vertical position, corresponding to a value on the price scale of a chart), where the object is to be placed | :'''PriceValue''' - a numerical expression specifying the price value (vertical position, corresponding to a value on the price scale of a chart), where the object is to be placed. | ||
== 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 == | |||
Move the arrow object with an ID number of 3 to the top of the current bar: | Move the arrow object with an ID number of 3 to the top of the current bar: | ||
<syntaxhighlight>Value1=Arw_SetLocation_s(3,Date,Time_s,High);</syntaxhighlight> | <syntaxhighlight>Value1 = Arw_SetLocation_s(3, Date, Time_s, High);</syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] |
Latest revision as of 09:01, 19 February 2012
Modifies the location of an arrow object with the specified ID number.
Arw_SetLocation_s returns a value of 0 if the location of the object was successfully modified, and a value of -2 if the specified object ID number is invalid.
Usage
Arw_SetLocation_s(ObjectID, BarDate, BarTime_s, PriceValue)
Parameters
- ObjectID - a numerical expression specifying the object ID number.
- BarDate - a numerical expression specifying the date of the bar at which the object is to be placed; the date is indicated in the YYYMMdd format, where YYY is the number of years since 1900, MM is the month, and dd is the day of the month.
- BarTime_s - a numerical expression specifying the time of the bar, including seconds, at which the object is to be placed; the time is indicated in the 24-hour HHmmss format, where 130000 = 1:00:00 PM.
- PriceValue - a numerical expression specifying the price value (vertical position, corresponding to a value on the price scale of a chart), where the object is to be placed.
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
Move the arrow object with an ID number of 3 to the top of the current bar:
Value1 = Arw_SetLocation_s(3, Date, Time_s, High);