Difference between revisions of "Text GetTime"
Jump to navigation
Jump to search
(Created page with "Returns a numerical value, indicating the time 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...") |
|||
| Line 1: | Line 1: | ||
| − | Returns a numerical value, indicating the time of the bar at which a text object with the specified ID number has been placed | + | Returns a numerical value, indicating the time of the bar at which a text object with the specified ID number has been placed. |
| − | The time is indicated in the 24-hour HHmm format, where 1300 = 1:00 PM. | + | 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 == | |
<syntaxhighlight>Text_GetTime(ObjectID)</syntaxhighlight> | <syntaxhighlight>Text_GetTime(ObjectID)</syntaxhighlight> | ||
| − | Where: | + | 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. | + | * 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. | ||
| − | + | == 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(3);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Text_GetTime(3);</syntaxhighlight> |
[[Category:Text Drawing]] | [[Category:Text Drawing]] | ||
Revision as of 08:29, 9 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.
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);
