Arw GetTime s: Difference between revisions
From MultiCharts
(Created page with "Returns a numerical value indicating the time of the bar, including seconds, at which an arrow object with the specified ID number has been placed; returns a value of -2 if th...") |
m (→Notes) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Returns a numerical value indicating the time of the bar, including seconds, at which an arrow object with the specified ID number has been placed | Returns a numerical value indicating the time of the bar, including seconds, at which an arrow object with the specified ID number has been placed. | ||
The time is indicated in the 24-hour HHmmss format, where 130000 = 1:00:00 PM. | Arw_GetTime_s returns a value of -2 if the specified object ID number is invalid. | ||
The time is indicated in the 24-hour ''HHmmss'' format, where 130000 = 1:00:00 PM. See the category [[:Category:Date_and_Time_Routines|Date and Time Routines]] for the PowerLanguage keywords for working with times. | |||
== Usage == | |||
<syntaxhighlight>Arw_GetTime_s(ObjectID)</syntaxhighlight> | <syntaxhighlight>Arw_GetTime_s(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. | |||
* Use [[Arw_GetTime]] to get the time of an arrow with minute precision. | |||
== Example == | |||
Assign a value, indicating the time of the bar at which an arrow object with the ID number of 3 has been placed, to Value1 variable: | Assign a value, indicating the time of the bar at which an arrow object with the ID number of 3 has been placed, to Value1 variable: | ||
<syntaxhighlight>Value1=Arw_GetTime_s(3);</syntaxhighlight> | <syntaxhighlight>Value1 = Arw_GetTime_s(3);</syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 08:47, 19 February 2012
Returns a numerical value indicating the time of the bar, including seconds, at which an arrow object with the specified ID number has been placed.
Arw_GetTime_s returns a value of -2 if the specified object ID number is invalid.
The time is indicated in the 24-hour HHmmss format, where 130000 = 1:00:00 PM. See the category Date and Time Routines for the PowerLanguage keywords for working with times.
Usage
Arw_GetTime_s(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.
- Use Arw_GetTime to get the time of an arrow with minute precision.
Example
Assign a value, indicating the time of the bar at which an arrow object with the ID number of 3 has been placed, to Value1 variable:
Value1 = Arw_GetTime_s(3);