$Time: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 2: | Line 2: | ||
<p>Returns the current time of day in the format specified.</p> | <p>Returns the current time of day in the format specified.</p> | ||
<b>Syntax</b> | <b>Syntax</b> | ||
<p class="code">$ | <p class="code">$Time(time-format,'first-delimiter', | ||
'second-delimiter') | 'second-delimiter') | ||
</p> | </p> | ||
| Line 43: | Line 43: | ||
<table> | <table> | ||
<tr class="head"> | <tr class="head"> | ||
<th>$ | <th>$Time(argument) </th> | ||
<th>Returns...</th> | <th>Returns...</th> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>[[$ | <td>[[$Time]]</td> | ||
<td>HH:MM:SS</td> | <td>HH:MM:SS</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>$ | <td>$Time(1) </td> | ||
<td>HH:MM:SS</td> | <td>HH:MM:SS</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>$ | <td>$Time(1,'-') </td> | ||
<td>HH-MM-SS</td> | <td>HH-MM-SS</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>$ | <td>$Time(1,' ') </td> | ||
<td>HH MM SS</td> | <td>HH MM SS</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>$ | <td>$Time(1,'') </td> | ||
<td>HHMMSS</td> | <td>HHMMSS</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>$ | <td>$Time(2) </td> | ||
<td>HH:MM:SS.TTT</td> | <td>HH:MM:SS.TTT</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>$ | <td>$Time(2,'-') </td> | ||
<td>HH-MM-SS.TTT</td> | <td>HH-MM-SS.TTT</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>$ | <td>$Time(2,'','') </td> | ||
<td>HHMMSSTTT</td> | <td>HHMMSSTTT</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
[[Category:SOUL $functions]] | [[Category:SOUL $functions]] | ||
Revision as of 15:21, 31 July 2014
Function
Returns the current time of day in the format specified.
Syntax
$Time(time-format,'first-delimiter', 'second-delimiter')
Where
| Argument | Value | Specifies | Default value |
|---|---|---|---|
| time-format | 1 | Returns the time of day as hhdmmdss (d=delimiter) | 1 |
| 2 | Returns the time of day as hhdmmdssdttt (d=delimiter) | ||
| first-delimiter | 1 character only | Character to place between time units HH, MM, and SS | : (colon) |
| second-delimiter | 1 character only, second-delimiter | Character to place between time units SS and TTT | . (period) |
The second-delimiter applies only if time-format is 2. You must enclose the delimiters with single quotation marks.
You can suppress either the first-delimiter or second-delimiter character by using a single quoted null string.
Examples
| $Time(argument) | Returns... |
|---|---|
| $Time | HH:MM:SS |
| $Time(1) | HH:MM:SS |
| $Time(1,'-') | HH-MM-SS |
| $Time(1,' ') | HH MM SS |
| $Time(1,) | HHMMSS |
| $Time(2) | HH:MM:SS.TTT |
| $Time(2,'-') | HH-MM-SS.TTT |
| $Time(2,,) | HHMMSSTTT |