$Sir DateFmt: Difference between revisions

Revision as of 22:33, 8 February 2012

Validate datetime format

Most Sirius $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

<section begin="syntax" /> %tst = $Sir_DateFmt(fmt) <section end="syntax" />

Syntax terms

fmt	Datetime format string. Refer to "Datetime string formats" for an explanation of valid datetime format strings.
%tst	Set to 1 if `fmt` is a valid datetime format string, otherwise set to 0.

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

Products authorizing $Sir_DateFmt

@@ Line 4: / Line 4: @@
 <p class="warning">Most Sirius $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==
@@ Line 14: / Line 14: @@
 <table class="syntaxTable">
 <tr><th>fmt</th>
-<td>datetime format string. Refer to [[Datetime string formats|"Datetime string formats"]] for an explanation of valid datetime format strings.</td></tr>
+<td>Datetime format string. Refer to [[Datetime string formats|"Datetime string formats"]] for an explanation of valid datetime format strings.</td></tr>
 <tr><th>%tst</th>
-<td>set to 1 if '''fmt''' is a valid datetime format string, otherwise set to 0.
+<td>Set to 1 if <var class="term">fmt</var> is a valid datetime format string, otherwise set to 0.
 </td></tr>
 </table>
+==Usage notes==
+<ul>
+<li>This $function has no error conditions.
+</ul>
 ==Example==
-The following fragment prints the string <tt>Good</tt>:
+The following fragment prints the string <code>Good</code>:
-<p class="code"> %X = $Sir_DateFmt('CYYDDDHHMISSXXX')
+<p class="code">%x = $Sir_DateFmt('CYYDDDHHMISSXXX')
- IF %X = 1 THEN
+If %x = 1 Then
-    PRINT 'Good'
+   Print 'Good'
- ELSE
+Else
-    PRINT 'Bad'
+   Print 'Bad'
- END IF
+End If
 </p>
-This $function has no error conditions.
 <ul class="smallAndTightList">