Text GetTime s: Difference between revisions
From MultiCharts
(Created page with "Returns a numerical value indicating the time, including seconds, of the bar at which a text object with the specified ID number has been placed; returns a value of -2 if the ...") |
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Returns a numerical value indicating the time, including seconds, of the bar at which a text object with the specified ID number has been placed; returns a value of -2 if the specified object ID number is invalid. | Returns a numerical value indicating the time, including seconds, of the bar at which a text object with the specified ID number has been placed; 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. | The time is indicated in the 24-hour ''HHmmss'' format, where 130000 = 1:00:00 PM. | ||
== Usage == | |||
<syntaxhighlight>Text_GetTime_s(ObjectID)</syntaxhighlight> | <syntaxhighlight>Text_GetTime_s(ObjectID)</syntaxhighlight> | ||
Where: | Where: | ||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
== Notes == | |||
An object-specific ID number is returned by [[Text_New_s]] when the text object is created. | * An object-specific ID number is returned by [[Text_New_s]] when the text object is created. | ||
* Use [[Text_GetTime]] to get the time of a text object with minute 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: | 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: | ||
<syntaxhighlight>Value1=Text_GetTime_s(3);</syntaxhighlight> | <syntaxhighlight>Value1 = Text_GetTime_s(3);</syntaxhighlight> | ||
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Latest revision as of 13:10, 13 February 2012
Returns a numerical value indicating the time, including seconds, of the bar at which a text object with the specified ID number has been placed; 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.
Usage
Text_GetTime_s(ObjectID)Where:
- ObjectID - a numerical expression specifying the object ID number.
Notes
- An object-specific ID number is returned by Text_New_s when the text object is created.
- Use Text_GetTime to get the time of a text object with minute 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_s(3);