$Sir Date: Difference between revisions

Revision as of 22:55, 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')

Products authorizing $Sir_Date

@@ Line 13: / Line 13: @@
 <table class="syntaxTable">
+<tr><th>%odate</th>
+<td>Set to contain the current date and time, in the format specified by <var class="term">fmt</var>.
+</td></tr>
 <tr><th>fmt</th>
 <td>Optional datetime format string, defaults to 'YY-MM-DD'. Refer to [[Datetime string formats|"Datetime string formats"]] for an explanation of valid datetime formats and valid datetime values.</td></tr>
 <tr><th>errctl</th>
 <td>Optional error control string; refer to [[Datetime string formats#Datetime error handling|"Datetime error handling"]].</td></tr>
-<tr><th>%odate</th>
-<td>Set to contain the current date and time, in the format specified by <var class="term">fmt</var>.
-</td></tr>
 </table>