Difference between revisions of "Arw GetTime"
Jump to navigation
Jump to search
Line 3: | Line 3: | ||
Arw_GetTime returns a value of -2 if the specified object ID number is invalid. | Arw_GetTime returns a value of -2 if the specified object ID number is invalid. | ||
− | The time is indicated in the 24-hour ''HHmm'' format, where 1300 = 1:00 PM. | + | The time is indicated in the 24-hour ''HHmm'' format, where 1300 = 1:00 PM. See the category [[:Category:Date_and_Time_Routines|Date and Time Routines]] for the PowerLanguage keywords for working with times. |
== Usage == | == Usage == | ||
Line 15: | Line 15: | ||
* 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. | * 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_GetActive]], [[Arw_GetFirst]] or [[Arw_GetNext]] to get the object-specific ID number of an already created arrow. | ||
− | * | + | * Use [[Arw_GetTime_s]] to get the time of an arrow with seconds precision. |
== Example == | == Example == |
Latest revision as of 08:48, 19 February 2012
Returns a numerical value, indicating the time of the bar at which an arrow object with the specified ID number has been placed.
Arw_GetTime returns a value of -2 if the specified object ID number is invalid.
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 times.
Usage
Arw_GetTime(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_s to get the time of an arrow with seconds 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 the Value1 variable:
Value1 = Arw_GetTime(3);