Difference between revisions of "Text GetDate"
Jump to navigation
Jump to search
(Created page with "Returns a numerical value, indicating the date 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 date of the bar at which a text object with the specified ID number has been placed | + | Returns a numerical value, indicating the date of the bar at which a text object with the specified ID number has been placed. |
− | The date is indicated in the YYYMMdd format, where YYY is the number of years since 1900, MM is the month, and dd is the day of the month. | + | Text_GetDate will return a value of -2 if the specified object ID number is invalid. |
+ | |||
+ | The date is indicated in the ''YYYMMdd'' format, where YYY is the number of years since 1900, MM is the month, and dd is the day of the month. | ||
− | + | == Usage == | |
<syntaxhighlight>Text_GetDate(ObjectID)</syntaxhighlight> | <syntaxhighlight>Text_GetDate(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. | ||
− | + | == Example == | |
Assign a value, indicating the date 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 date of the bar at which a text object with the ID number of 3 has been placed, to Value1 variable: | ||
− | <syntaxhighlight>Value1=Text_GetDate(3);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Text_GetDate(3);</syntaxhighlight> |
[[Category:Text Drawing]] | [[Category:Text Drawing]] |
Revision as of 07:55, 9 February 2012
Returns a numerical value, indicating the date of the bar at which a text object with the specified ID number has been placed.
Text_GetDate will return a value of -2 if the specified object ID number is invalid.
The date is indicated in the YYYMMdd format, where YYY is the number of years since 1900, MM is the month, and dd is the day of the month.
Usage
Text_GetDate(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.
Example
Assign a value, indicating the date of the bar at which a text object with the ID number of 3 has been placed, to Value1 variable:
Value1 = Text_GetDate(3);