1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_dt_set_tz">
<refmeta>
<refentrytitle>dt_set_tz</refentrytitle>
<refmiscinfo>time</refmiscinfo>
</refmeta>
<refnamediv>
<refname>dt_set_tz</refname>
<refpurpose>modifies the timezone component of a datetime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_dt_set_tz">
<funcprototype id="fproto_dt_set_tz">
<funcdef><function>dt_set_tz</function></funcdef>
<paramdef>in <parameter>dt</parameter> datetime</paramdef>
<paramdef>in <parameter>tz</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_dt_set_tz"><title>Description</title>
<para>This modifies the timezone component of a datetime.
The value remains equal for purposes of comparison but will look
different when converted to a string. The timezone component is an
offset from UTC in minutes. It can be retrieved with the timezone
function.</para>
<para>Timezoneless: The function returns its first argument with unchanged GMT value but new timezone offset. Unlike
<link linkend="fn_adjust_timezone"><function>adjust_timezone()</function></link>, if the argument is timezoneless then no
error is signaled.</para>
</refsect1>
<refsect1 id="params_dt_set_tz"><title>Parameters</title>
<refsect2><title>dt</title>
<para>The original <type>DATETIME</type>.</para>
</refsect2>
<refsect2><title>tz</title>
<para><type>INTEGER</type> new timezone offset.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_dt_set_tz"><title>Return Types</title>
<para>A <type>DATETIME</type> with the new timezone set</para>
</refsect1>
<!-- <refsect1 id="errors_dt_set_tz"><title>Errors</title>
<table><title>Errors signalled by <function>dt_set_tz</function></title>
<tgroup cols="4">
<thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode></errorcode></entry>
<entry><errorcode></errorcode></entry>
<entry><errorname></errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="examples_dt_set_tz"><title>Examples</title>
<example id="ex_dt_set_tz"><title></title>
<para></para>
<screen></screen>
</example>
</refsect1>
<refsect1 id="seealso_dt_set_tz"><title>See Also</title>
<para><link linkend="fn"></link></para>
</refsect1>
-->
</refentry>
|