$Sir DateCnv: Difference between revisions
(Created page with "{{DISPLAYTITLE:$Sir_DateCnv}} <span class="pageSubtitle">Convert datetime to different format</span> <p class="warn"><b>Note:</b> This $function require the <var class="produ...") |
m (minor formatting) |
||
| Line 7: | Line 7: | ||
input string, a datetime format for the output string, and a datetime | input string, a datetime format for the output string, and a datetime | ||
value to be converted. | value to be converted. | ||
It also accepts an optional <var>CENTSPAN</var> value and an optional | It also accepts an optional <var>[[Datetime string formats#Using CENTSPAN|CENTSPAN]]</var> value and an optional error control string.</p> | ||
error control string.</p> | |||
<p> | <p> | ||
<var>$Sir_DateCnv</var> returns the input datetime converted to the output format.</p> | <var>$Sir_DateCnv</var> returns the input datetime converted to the output format.</p> | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%odat</span> = $Sir_DateCnv(<span class="term">infmt, outfmt, dat, span, errctl</span>) | <p class="syntax"><span class="term">%odat</span> = $Sir_DateCnv(<span class="term">infmt</span>, <span class="term">outfmt</span>, <span class="term">dat</span>, [<span class="term">span</span>], [<span class="term">errctl</span>]) | ||
</p> | </p> | ||
Where: | Where: | ||
<table> | <table> | ||
<tr><th>%odat</th> | |||
<td>Set to the value of <var class="term">dat</var>, converted from the format in <var class="term">infmt</var> to the format in <var class="term">outfmt</var>, unless an error is detected.</td></tr> | |||
<tr><th>infmt</th> | <tr><th>infmt</th> | ||
<td>Datetime format string for <var class="term">dat</var>. Refer to [[Datetime string formats]] for an explanation of valid datetime formats and valid dates. Strict matching is used for <var class="term">infmt</var>.</td></tr> | <td>Datetime format string for <var class="term">dat</var>. Refer to [[Datetime string formats]] for an explanation of valid datetime formats and valid dates. Strict matching is used for <var class="term">infmt</var>.</td></tr> | ||
| Line 31: | Line 33: | ||
<tr><th>errctl</th> | <tr><th>errctl</th> | ||
<td>Optional error control string, refer to [[Datetime string formats#Datetime error handling|Datetime error handling]].</td></tr> | <td>Optional error control string, refer to [[Datetime string formats#Datetime error handling|Datetime error handling]].</td></tr> | ||
</table> | </table> | ||
Revision as of 21:20, 23 September 2015
Convert datetime to different format
Note: This $function require the Sir2000 User Language Tools product.
The $Sir_DateCnv function expects a datetime format string for the input string, a datetime format for the output string, and a datetime value to be converted. It also accepts an optional CENTSPAN value and an optional error control string.
$Sir_DateCnv returns the input datetime converted to the output format.
Syntax
%odat = $Sir_DateCnv(infmt, outfmt, dat, [span], [errctl])
Where:
| %odat | Set to the value of dat, converted from the format in infmt to the format in outfmt, unless an error is detected. |
|---|---|
| infmt | Datetime format string for dat. Refer to Datetime string formats for an explanation of valid datetime formats and valid dates. Strict matching is used for infmt. |
| outfmt | Datetime format string for function output (%odat). |
| dat | Input datetime string. |
| span | Optional CENTSPAN value, default is -50. Refer to Using CENTSPAN. |
| errctl | Optional error control string, refer to Datetime error handling. |
Example
The following fragment prints the string 19970101:
Print $sir_datecnv('YYMMDD', 'YYYYMMDD', '970101', 1950)
Error conditions
$Sir_DateCnv returns a string composed of all asterisks (*), whose length is the shorter of the length of the output date format string or 32, in the following error cases:
- infmt or outfmt is not a valid datetime format string.
- dat does not match infmt.
- dat is outside of range permitted for infmt or that permitted for outfmt.
- span is invalid.
For more information about error handling, see the APPDATE command, and see Sir_Date_Err.