$Sir Date: Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Syntax) |
||
Line 7: | Line 7: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %odate = $Sir_Date(fmt, errctl) | <p class="syntax"><section begin="syntax" /><span class="term">%odate</span> <span class="literal">= $Sir_Date(</span><span class="term">fmt</span><span class="literal">,</span> <span class="term">errctl</span><span class="literal">)</span> | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
Revision as of 22:58, 8 February 2012
Get current datetime
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent of $Sir_Date is CurrentTimeString.
This function accepts an optional datetime format string and an optional error control string, and returns the current date and time as a character string with the specified format.
Syntax
<section begin="syntax" />%odate = $Sir_Date(fmt, errctl) <section end="syntax" />
Syntax terms
%odate | Set to contain the current date and time, in the format specified by fmt. |
---|---|
fmt | Optional datetime format string, defaults to 'YY-MM-DD'. Refer to "Datetime string formats" for an explanation of valid datetime formats and valid datetime values. |
errctl | Optional error control string; refer to "Datetime error handling". |
Usage notes
- $Sir_Date returns the null string in the following error case: fmt is not a valid datetime format. For more information about error handling, see "Datetime error handling").
Example
The following fragment prints a value such as Monday, 1 January 2001 AT 01:11:10 PM
:
Print $Sir_Date('Wkday, DAY Month YYYY' WITH ' "A"T HH:MI:SS AM')