Difference between revisions of "Arw SetLocation"

From MultiCharts
Jump to navigation Jump to search
m (Reverted edits by 176.8.90.7 (talk) to last revision by 194.84.116.138)
Line 1: Line 1:
Modifies the location of an arrow object with the specified ID number; 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.  
+
Modifies the location of an arrow object with the specified ID number.
 +
 
 +
Arw_SetLocation 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 ====
+
== Usage ==
<syntaxhighlight>Arw_SetLocation (ObjectID, BarDate, BarTime, PriceValue)</syntaxhighlight>  
+
<syntaxhighlight>Arw_SetLocation(ObjectID, BarDate, BarTime, PriceValue)</syntaxhighlight>  
  
==== Parameters ====  
+
== 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 - a numerical expression specifying the time of the bar at which the object is to be placed; the time is indicated in the 24-hour HHmm format, where 1300 = 1:00 PM  
+
:'''BarTime''' - a numerical expression specifying the time of the bar at which the object is to be placed; the time is indicated in the 24-hour ''HHmm'' format, where 1300 = 1: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  
+
::See the category [[:Category:Date_and_Time_Routines|Date and Time Routines]] for the PowerLanguage keywords for working with dates and times.
 +
 
 +
:'''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 ====  
 
==== Notes ====  
An object-specific ID number is returned by [[Arw_New]] when the arrow object is created.
+
* 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 ====
+
== 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(3,Date,Time,High);</syntaxhighlight>
+
<syntaxhighlight>Value1 = Arw_SetLocation(3, Date, Time, High);</syntaxhighlight>
 
 
  
 
[[Category:ArrowDrawing]]
 
[[Category:ArrowDrawing]]

Revision as of 08:28, 19 February 2012

Modifies the location of an arrow object with the specified ID number.

Arw_SetLocation 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(ObjectID, BarDate, BarTime, 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 - a numerical expression specifying the time of the bar at which the object is to be placed; the time is indicated in the 24-hour HHmm format, where 1300 = 1:00 PM.
See the category Date and Time Routines for the PowerLanguage keywords for working with dates and times.
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

Example

Move the arrow object with an ID number of 3 to the top of the current bar:

Value1 = Arw_SetLocation(3, Date, Time, High);