$Sir Date: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Get current datetime<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Get current datetime<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent of <var>$Sir_Date</var> is <var>[[CurrentTimeString (System function)|CurrentTimeString]]</var>.</p> | ||
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. | 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. |
Revision as of 18:47, 27 March 2011
<section begin="desc" />Get current datetime<section end="desc" />
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" />
where
fmt | optional datetime format string, defaults to 'YY-MM-DD'. Refer to for an explanation of valid datetime formats and valid datetime values. |
---|---|
errctl | optional error control string, refer to . |
%odate | set to contain the current date and time, in the format specified by fmt. |
For 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')
Error conditions are shown in the following figure (see the discussion in ).
- fmt is not a valid datetime format.