$Time: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Mlarocca moved page $TIME to $Time: Lower case change)
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<b>Function</b>
<p>
<p>Returns the current time of day in the format specified.</p>
Returns the current time of day in the format specified.</p>
<b>Syntax</b>
 
<p class="code">$TIME(time-format,'first-delimiter',
==Syntax==
      'second-delimiter')
<p class="syntax">$Time(<span class="term">time-format,'first-delimiter', 'second-delimiter'</span>)
</p>
</p>
<b>Where</b>
Where:
<table>
<table>
<tr class="head">
<tr class="head">
Line 13: Line 13:
<th>Default value</th>
<th>Default value</th>
</tr>
</tr>
<tr><th rowspan="2">time-format</th>
<td>1</td>
<td>Returns the time of day as <code>hhdmmdss</code> (<code>d</code> is the delimiter)</td>
<td align="right">1</td></tr>
<tr>
<tr>
<td>time-format</td>
<td>2 </td>
<td align="right">1</td>
<td>Returns the time of day as <code>hhdmmdssdttt</code> (<code>d</code> is the delimiter)</td>
<td>Returns the time of day as hhdmmdss (d=delimiter)</td>
<td>&nbsp;</td></tr>
<td align="right">1</td>
 
</tr>
<tr><th>first-delimiter </th>
<tr>
<td>&nbsp;</td>
<td align="right">2 </td>
<td>Returns the time of day as hhdmmdssdttt (d=delimiter)</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>first-delimiter </td>
<td>1 character only </td>
<td>1 character only </td>
<td>Character to place between time units HH, MM, and SS</td>
<td>Character to place between time units <var>HH</var>, <var>MM</var>, and <var>SS</var></td>
<td>: (colon)</td>
<td><b>:</b> (colon)</td></tr>
</tr>
 
<tr>
<tr><th nowrap>second-delimiter </th>
<td>second-delimiter </td>
<td>1 character only, second-delimiter</td>
<td>1 character only, second-delimiter</td>
<td>Character to place between time units SS and TTT</td>
<td>Character to place between time units <var>SS</var> and <var>TTT</var></td>
<td>. (period)</td>
<td><b>.</b> (period)</td></tr>
</tr>
</table>
</table>
<p>The second-delimiter applies only if time-format is 2. You must enclose the delimiters with single quotation marks.</p>
<p>
<p>You can suppress either the first-delimiter or second-delimiter character by using a single quoted null string.</p>
The second-delimiter applies only if time-format is <code>2</code>. You must enclose the delimiters with single quotation marks.</p>
<b>Examples</b>
<p>
You can suppress the first-delimiter or the second-delimiter character by using a single quoted null string. To suppress both delimiters, use two single quoted null strings separated by a comma.</p>
 
==Examples==
<table>
<table>
<tr class="head">
<tr class="head">
<th>$TIME(argument) </th>
<th>$Time(argument) </th>
<th>Returns...</th>
<th>Returns...</th>
</tr>
</tr>
<tr>
 
<td>[[$TIME]]</td>
<tr><td>$Time</td>
<td>HH:MM:SS</td>
<td>HH:MM:SS</td>
</tr>
</tr>
<tr>
 
<td>$TIME(1) </td>
<tr><td>$Time(1) </td>
<td>HH:MM:SS</td>
<td>HH:MM:SS</td>
</tr>
</tr>
<tr>
 
<td>$TIME(1,'-') </td>
<tr><td>$Time(1,'-') </td>
<td>HH-MM-SS</td>
<td>HH-MM-SS</td></tr>
</tr>
 
<tr>
<tr><td>$Time(1,' ') </td>
<td>$TIME(1,' ') </td>
<td>HH MM SS</td></tr>
<td>HH MM SS</td>
 
</tr>
<tr><td>$Time(1,&apos;&apos;) </td>
<tr>
<td>HHMMSS</td></tr>
<td>$TIME(1,'') </td>
 
<td>HHMMSS</td>
<tr><td>$Time(2) </td>
</tr>
<tr>
<td>$TIME(2) </td>
<td>HH:MM:SS.TTT</td>
<td>HH:MM:SS.TTT</td>
</tr>
</tr>
<tr>
 
<td>$TIME(2,'-') </td>
<tr><td>$Time(2,'-') </td>
<td>HH-MM-SS.TTT</td>
<td>HH-MM-SS.TTT</td>
</tr>
</tr>
<tr>
 
<td>$TIME(2,'','') </td>
<tr><td>$Time(2,&apos;',&apos;')</td>
<td>HHMMSSTTT</td>
<td>HHMMSSTTT</td></tr>
</tr>
</table>
</table>
[[Category:SOUL $functions]]
[[Category:SOUL $functions]]

Latest revision as of 17:15, 24 April 2017

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 is the delimiter) 1
2 Returns the time of day as hhdmmdssdttt (d is the 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 the first-delimiter or the second-delimiter character by using a single quoted null string. To suppress both delimiters, use two single quoted null strings separated by a comma.

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