Difference between revisions of "Arw GetDate"
Jump to navigation
Jump to search
(Created page with "Returns a numerical value, indicating the date of the bar at which an arrow object with the specified ID number has been placed; returns a value of -2 if the specified object ...") |
|||
(3 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | Returns a numerical value, indicating the date of the bar at which an arrow object with the specified ID number has been placed | + | Returns a numerical value, indicating the date of the bar at which an arrow 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. | + | Arw_GetDate returns 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. See the category [[:Category:Date_and_Time_Routines|Date and Time Routines]] for the PowerLanguage keywords for working with dates. | ||
− | + | == Usage == | |
<syntaxhighlight>Arw_GetDate(ObjectID)</syntaxhighlight> | <syntaxhighlight>Arw_GetDate(ObjectID)</syntaxhighlight> | ||
− | Where: | + | Where: |
+ | |||
+ | :'''ObjectID''' - a numerical expression specifying the object ID number. | ||
− | + | == Notes == | |
− | An object-specific ID number is | + | * 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. | ||
− | + | == Example == | |
Assign a value, indicating the date of the bar at which an arrow object with the ID number of 3 has been placed, to Value1 variable: | Assign a value, indicating the date of the bar at which an arrow object with the ID number of 3 has been placed, to Value1 variable: | ||
− | <syntaxhighlight>Value1=Arw_GetDate(3);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Arw_GetDate(3);</syntaxhighlight> |
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] |
Latest revision as of 08:25, 19 February 2012
Returns a numerical value, indicating the date of the bar at which an arrow object with the specified ID number has been placed.
Arw_GetDate returns 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. See the category Date and Time Routines for the PowerLanguage keywords for working with dates.
Usage
Arw_GetDate(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.
Example
Assign a value, indicating the date of the bar at which an arrow object with the ID number of 3 has been placed, to Value1 variable:
Value1 = Arw_GetDate(3);