Text GetTime: Difference between revisions
From MultiCharts
(→Usage) |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
| Line 5: | Line 5: | ||
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. | ||
== Usage == | |||
<syntaxhighlight>Text_GetTime(ObjectID)</syntaxhighlight> | |||
Where: | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
== Notes == | == Notes == | ||
* An object-specific ID number is returned by [[Text_New]] when the text object is created. | * An object-specific ID number is returned by [[Text_New]] when the text object is created. | ||
Latest revision as of 13:12, 13 February 2012
Returns a numerical value, indicating the time of the bar at which a text object with the specified ID number has been placed.
Text_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.
Usage
Text_GetTime(ObjectID)Where:
- ObjectID - a numerical expression specifying the object ID number.
Notes
- An object-specific ID number is returned by Text_New when the text object is created.
- Use Text_GetTime_s to get the time of a text object with seconds precision.
- Use Text_GetDate to get the date of a text object.
Example
Assign a value, indicating the time of the bar at which a text object with the ID number of 3 has been placed, to Value1 variable:
Value1 = Text_GetTime(3);