$Sir DateCnv - Revision history

JAL: link repair

2018-02-08T22:53:38Z

link repair

← Older revision		Revision as of 22:53, 8 February 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Convert datetime to different format</span>		<span class="pageSubtitle">Convert datetime to different format</span>

	<p class="warn"><b>Note:</b> This $function require the <var class="product">[[~~Media:Ul2krNew.pdf\|~~Sir2000 User Language Tools]]</var> product. </p>		<p class="warn"><b>Note:</b> This $function require the <var class="product">[[Sir2000 User Language Tools]]</var> product. </p>
	<p>		<p>
	The <var>$Sir_DateCnv</var> function expects a datetime format string for the		The <var>$Sir_DateCnv</var> function expects a datetime format string for the

JAL: /* Error conditions */ change link for error info

2018-02-08T21:23:50Z

Error conditions: change link for error info

← Older revision		Revision as of 21:23, 8 February 2018
Line 59:		Line 59:

	<p>		<p>
	For more information about error handling, see ~~the <var>~~[[~~APPDATE command~~\|~~APPDATE]]</var> command,~~		For more information about error handling, see [[Sir2000 User Language Tools $functions#Errors in datetime $functions\|Errors in datetime $functions]]. </p>
	~~and see <var>[[~~$~~Sir_Date_Err~~]]~~</var>~~. </p>

	[[Category:Sir2000 User Language Tools $functions]]		[[Category:Sir2000 User Language Tools $functions]]

JAL: change link for error control

2018-02-08T21:15:12Z

change link for error control

← Older revision		Revision as of 21:15, 8 February 2018
Line 32:		Line 32:

	<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 [[The Sir2000 APPDATE command#Error handling control with DATE ERR\|Error handling control with DATE_ERR]].</td></tr>
	</table>		</table>

JAL: link repair

2015-10-05T21:37:28Z

link repair

← Older revision		Revision as of 21:37, 5 October 2015
Line 60:		Line 60:
	<p>		<p>
	For more information about error handling, see the <var>[[APPDATE command\|APPDATE]]</var> command,		For more information about error handling, see the <var>[[APPDATE command\|APPDATE]]</var> command,
	and see <var>[[Sir_Date_Err]]</var>. </p>		and see <var>[[$Sir_Date_Err]]</var>. </p>

	[[Category:Sir2000 User Language Tools $functions]]		[[Category:Sir2000 User Language Tools $functions]]

JAL: remove category

2015-09-24T23:57:41Z

remove category

← Older revision		Revision as of 23:57, 24 September 2015
Line 62:		Line 62:
	and see <var>[[Sir_Date_Err]]</var>. </p>		and see <var>[[Sir_Date_Err]]</var>. </p>

	~~[[Category:$Functions\|$Sir_DateCnv]]~~
	[[Category:Sir2000 User Language Tools $functions]]		[[Category:Sir2000 User Language Tools $functions]]

JAL: add link

2015-09-24T23:42:35Z

add link

← Older revision		Revision as of 23:42, 24 September 2015
Line 20:		Line 20:

	<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. [[Datetime string formats#Strict and non-strict format matching\|Strict matching]] is used for <var class="term">infmt</var>.</td></tr>

	<tr><th>outfmt</th>		<tr><th>outfmt</th>

JAL: minor formatting

2015-09-23T21:20:52Z

minor formatting

← Older revision		Revision as of 21:20, 23 September 2015
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>

	~~<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>~~
	</table>		</table>

JAL: Created page with "{{DISPLAYTITLE:$Sir_DateCnv}} Convert datetime to different format
Note: This $function require the
2015-09-23T21:12:23Z

Created page with "{{DISPLAYTITLE:$Sir_DateCnv}} Convert datetime to different format Note: This $function require the <var class="produ..."

New page
{{DISPLAYTITLE:$Sir_DateCnv}}
Convert datetime to different format

Note: This $function require the <var class="product">[[Media:Ul2krNew.pdf|Sir2000 User Language Tools]]</var> product. 

The <var>$Sir_DateCnv</var> 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 <var>CENTSPAN</var> value and an optional
error control string.

<var>$Sir_DateCnv</var> returns the input datetime converted to the output format.

==Syntax==
%odat = $Sir_DateCnv(infmt, outfmt, dat, span, errctl)

Where:
<table>
<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>

<tr><th>outfmt</th>
<td>Datetime format string for function output (<var class="term">%odat</var>).</td></tr>

<tr><th>dat</th>
<td>Input datetime string.</td></tr>

<tr><th>span</th>
<td>Optional <var>CENTSPAN</var> value, default is -50. Refer to [[Datetime string formats#Using CENTSPAN|Using CENTSPAN]].</td></tr>

<tr><th>errctl</th>
<td>Optional error control string, refer to [[Datetime string formats#Datetime error handling|Datetime error handling]].</td></tr>

<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>
</table>

==Example==
The following fragment prints the string <code>19970101</code>:
Print $sir_datecnv('YYMMDD', 'YYYYMMDD', '970101', 1950)


==Error conditions==

<var>$Sir_DateCnv</var> returns a string composed of all asterisks (<tt>*</tt>),
whose length is the shorter of the length of the output date
format string or 32, in the following error cases:


<ul>
<li><var class="term">infmt</var> or <var class="term">outfmt</var> is not a valid datetime format string. </li>

<li><var class="term">dat</var> does not match <var class="term">infmt</var>. </li>

<li><var class="term">dat</var> is outside of range permitted for <var class="term">infmt</var>
or that permitted for <var class="term">outfmt</var>. </li>

<li><var class="term">span</var> is invalid. </li>
</ul>


For more information about error handling, see the <var>[[APPDATE command|APPDATE]]</var> command,
and see <var>[[Sir_Date_Err]]</var>. 

[[Category:$Functions|$Sir_DateCnv]]
[[Category:Sir2000 User Language Tools $functions]]