$Sir DateFmt: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (link repair) |
||
| (35 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Validate datetime format</span> | <span class="pageSubtitle">Validate datetime format</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Sir_DateFmt function.</p> | ||
The $Sir_DateFmt function expects a datetime format string and returns the value 1 if the datetime format is valid, else the value 0. | The <var>$Sir_DateFmt</var> function expects a datetime format string and returns the value 1 if the datetime format is valid, else the value 0. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%tst</span> <span class="literal">= $Sir_DateFmt(</span><span class="term">fmt</span><span class="literal">)</span> | ||
< | |||
< | |||
</p> | </p> | ||
===Syntax terms=== | |||
<table> | |||
<tr><th>%tst</th> | |||
<td>Set to 1 if <var class="term">fmt</var> is a valid datetime format string, otherwise set to 0. | |||
</td></tr> | |||
<tr><th>fmt</th> | <tr><th>fmt</th> | ||
<td> | <td>Datetime format string. Refer to [[Datetime string formats]] for an explanation of valid datetime format strings.</td></tr> | ||
</td></tr> | |||
</table> | </table> | ||
==Usage notes== | |||
<ul> | |||
<li>This $function has no error conditions. | |||
</ul> | |||
==Example== | |||
The following fragment prints the string <code>Good</code>: | |||
<p class="code"> % | <p class="code">%x = $Sir_DateFmt('CYYDDDHHMISSXXX') | ||
If %x = 1 Then | |||
Print 'Good' | |||
Else | |||
Print 'Bad' | |||
End If | |||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
<li>[[Sir2000 User Language Tools]]</li> | <li>[[Sir2000 User Language Tools]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Sir_DateFmt]] | [[Category:$Functions|$Sir_DateFmt]] | ||
Latest revision as of 22:49, 8 February 2018
Validate datetime format
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Sir_DateFmt function.
The $Sir_DateFmt function expects a datetime format string and returns the value 1 if the datetime format is valid, else the value 0.
Syntax
%tst = $Sir_DateFmt(fmt)
Syntax terms
| %tst | Set to 1 if fmt is a valid datetime format string, otherwise set to 0. |
|---|---|
| fmt | Datetime format string. Refer to Datetime string formats for an explanation of valid datetime format strings. |
Usage notes
- This $function has no error conditions.
Example
The following fragment prints the string Good:
%x = $Sir_DateFmt('CYYDDDHHMISSXXX') If %x = 1 Then Print 'Good' Else Print 'Bad' End If