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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 332615 $ -->
<refentry xml:id="intlcalendar.setskippedwalltimeoption" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlCalendar::setSkippedWallTimeOption</refname>
<refpurpose>Set behavior for handling skipped wall times at positive timezone offset transitions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setSkippedWallTimeOption</methodname>
<methodparam><type>int</type><parameter>wallTimeOption</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_set_skipped_wall_time_option</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>wallTimeOption</parameter></methodparam>
</methodsynopsis>
<para>
Sets the current strategy for dealing with wall times that are skipped
whenever the clock is forwarded during dailight saving time start transitions.
The default value is <constant>IntlCalendar::WALLTIME_LAST</constant> (take
it as being the same instant as the one when the wall time is one hour
more). Alternative values are
<constant>IntlCalendar::WALLTIME_FIRST</constant> (same instant as the one
with a wall time of one hour less) and
<constant>IntlCalendar::WALLTIME_NEXT_VALID</constant> (same instant as
when DST begins).
</para>
<para>
This affects only the instant represented by the calendar (as reported by
<function>IntlCalendar::getTime</function>), the field values will not be
rewritten accordingly.
</para>
<para>
The calendar must be <link
linkend="intlcalendar.setlenient">lenient</link> for this option to have
any effect, otherwise attempting to set a non-existing time will cause an
error.
</para>
<para>
This function requires ICU 4.9 or later.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
<para>
The IntlCalendar resource.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wallTimeOption</parameter></term>
<listitem>
<para>
One of the constants <constant>IntlCalendar::WALLTIME_FIRST</constant>,
<constant>IntlCalendar::WALLTIME_LAST</constant> or
<constant>IntlCalendar::WALLTIME_NEXT_VALID</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success. Failure can only happen due to invalid parameters.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
See the example on
<function>IntlCalendar::getSkippedWallTimeOption</function>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>intlCalendar::getSkippedWallTimeOption</methodname></member>
<member><methodname>intlCalendar::setRepeatedWallTimeOption</methodname></member>
<member><methodname>intlCalendar::getRepeatedWallTimeOption</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
