$Sir Date: Difference between revisions
Jump to navigation
Jump to search
m (→Syntax) |
mNo edit summary |
||
| Line 16: | Line 16: | ||
<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> | <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> | <tr><th>errctl</th> | ||
<td>Optional error control string; refer to [[Datetime string formats#Datetime | <td>Optional error control string; refer to [[Datetime string formats#Datetime error handling|"Datetime error handling"]].</td></tr> | ||
<tr><th>%odate</th> | <tr><th>%odate</th> | ||
<td>Set to contain the current date and time, in the format specified by <var class="term">fmt</var>. | <td>Set to contain the current date and time, in the format specified by <var class="term">fmt</var>. | ||
| Line 25: | Line 25: | ||
<ul> | <ul> | ||
<li>$Sir_Date returns the null string in the following error case: <var class="term">fmt</var> is not a valid datetime format. | <li>$Sir_Date returns the null string in the following error case: <var class="term">fmt</var> is not a valid datetime format. | ||
For more information about error handling, see [[Datetime string formats#Datetime | For more information about error handling, see [[Datetime string formats#Datetime error handling|"Datetime error handling"]]). | ||
</ul> | </ul> | ||
Revision as of 20: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
| 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". |
| %odate | Set to contain the current date and time, in the format specified by fmt. |
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')
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
- Sir2000 User Language Tools
Products authorizing $Sir_Date