1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--***********************************************************
4 *
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements.  See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership.  The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License.  You may obtain a copy of the License at
12 *
13 *   http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied.  See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 *
22 ***********************************************************-->
23
24<helpdocument version="1.0">
25<meta>
26<topic id="textsbasicshared03030120xhp" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">DateDiff Function [Runtime]</title>
28<filename>/text/sbasic/shared/03030120.xhp</filename>
29</topic>
30<comment>DateDiff</comment>
31</meta>
32<body>
33<section id="datediff">
34<bookmark xml-lang="en-US" branch="index" id="bm_id6134830"><bookmark_value>DateDiff function</bookmark_value>
35</bookmark>
36<paragraph role="heading" id="par_idN10542" xml-lang="en-US" level="1" l10n="NEW"><link href="text/sbasic/shared/03030120.xhp">DateDiff Function [Runtime]</link></paragraph>
37<paragraph role="paragraph" id="par_idN10546" xml-lang="en-US" l10n="NEW">Returns the number of date intervals between two given date values.</paragraph>
38</section>
39<paragraph role="heading" id="par_idN10549" xml-lang="en-US" level="2" l10n="NEW">Syntax:</paragraph>
40<paragraph role="paragraph" id="par_idN10648" xml-lang="en-US" l10n="NEW">DateDiff (Add, Date1, Date2 [, Week_start [, Year_start]])</paragraph>
41<paragraph role="heading" id="par_idN1064B" xml-lang="en-US" level="2" l10n="NEW">Return value:</paragraph>
42<paragraph role="paragraph" id="par_idN1064F" xml-lang="en-US" l10n="NEW">A number.</paragraph>
43<paragraph role="heading" id="par_idN10652" xml-lang="en-US" level="2" l10n="NEW">Parameters:</paragraph>
44<paragraph role="paragraph" id="par_idN10656" xml-lang="en-US" l10n="NEW">
45<emph>Add</emph> - A string expression from the following table, specifying the date interval.</paragraph>
46<embed href="text/sbasic/shared/03030110.xhp#datetable"/>
47<paragraph role="paragraph" id="par_idN10664" xml-lang="en-US" l10n="NEW">
48<emph>Date1, Date2</emph> - The two date values to be compared.</paragraph>
49<section id="weekyear">
50<paragraph role="paragraph" id="par_idN1066A" xml-lang="en-US" l10n="NEW">
51<emph>Week_start</emph> - An optional parameter that specifies the starting day of a week. </paragraph>
52<table id="tbl_id8356883">
53<tablerow>
54<tablecell colspan="" rowspan="">
55<paragraph role="tablehead" id="par_idN1067A" xml-lang="en-US" l10n="NEW">Week_start value</paragraph>
56</tablecell>
57<tablecell colspan="" rowspan="">
58<paragraph role="tablehead" id="par_idN10680" xml-lang="en-US" l10n="NEW">Explanation</paragraph>
59</tablecell>
60</tablerow>
61<tablerow>
62<tablecell colspan="" rowspan="">
63<paragraph role="tablecontent" id="par_idN10687" xml-lang="en-US" l10n="NEW">0</paragraph>
64</tablecell>
65<tablecell colspan="" rowspan="">
66<paragraph role="tablecontent" id="par_idN1068D" xml-lang="en-US" l10n="NEW">Use system default value</paragraph>
67</tablecell>
68</tablerow>
69<tablerow>
70<tablecell colspan="" rowspan="">
71<paragraph role="tablecontent" id="par_idN10694" xml-lang="en-US" l10n="NEW">1</paragraph>
72</tablecell>
73<tablecell colspan="" rowspan="">
74<paragraph role="tablecontent" id="par_idN1069A" xml-lang="en-US" l10n="NEW">Sunday (default)</paragraph>
75</tablecell>
76</tablerow>
77<tablerow>
78<tablecell colspan="" rowspan="">
79<paragraph role="tablecontent" id="par_idN106A1" xml-lang="en-US" l10n="NEW">2</paragraph>
80</tablecell>
81<tablecell colspan="" rowspan="">
82<paragraph role="tablecontent" id="par_idN106A7" xml-lang="en-US" l10n="NEW">Monday</paragraph>
83</tablecell>
84</tablerow>
85<tablerow>
86<tablecell colspan="" rowspan="">
87<paragraph role="tablecontent" id="par_idN106AE" xml-lang="en-US" l10n="NEW">3</paragraph>
88</tablecell>
89<tablecell colspan="" rowspan="">
90<paragraph role="tablecontent" id="par_idN106B4" xml-lang="en-US" l10n="NEW">Tuesday</paragraph>
91</tablecell>
92</tablerow>
93<tablerow>
94<tablecell colspan="" rowspan="">
95<paragraph role="tablecontent" id="par_idN106BB" xml-lang="en-US" l10n="NEW">4</paragraph>
96</tablecell>
97<tablecell colspan="" rowspan="">
98<paragraph role="tablecontent" id="par_idN106C1" xml-lang="en-US" l10n="NEW">Wednesday</paragraph>
99</tablecell>
100</tablerow>
101<tablerow>
102<tablecell colspan="" rowspan="">
103<paragraph role="tablecontent" id="par_idN106C8" xml-lang="en-US" l10n="NEW">5</paragraph>
104</tablecell>
105<tablecell colspan="" rowspan="">
106<paragraph role="tablecontent" id="par_idN106CE" xml-lang="en-US" l10n="NEW">Thursday</paragraph>
107</tablecell>
108</tablerow>
109<tablerow>
110<tablecell colspan="" rowspan="">
111<paragraph role="tablecontent" id="par_idN106D5" xml-lang="en-US" l10n="NEW">6</paragraph>
112</tablecell>
113<tablecell colspan="" rowspan="">
114<paragraph role="tablecontent" id="par_idN106DB" xml-lang="en-US" l10n="NEW">Friday</paragraph>
115</tablecell>
116</tablerow>
117<tablerow>
118<tablecell colspan="" rowspan="">
119<paragraph role="tablecontent" id="par_idN106E2" xml-lang="en-US" l10n="NEW">7</paragraph>
120</tablecell>
121<tablecell colspan="" rowspan="">
122<paragraph role="tablecontent" id="par_idN106E8" xml-lang="en-US" l10n="NEW">Saturday</paragraph>
123</tablecell>
124</tablerow>
125</table>
126<paragraph role="paragraph" id="par_idN106EB" xml-lang="en-US" l10n="NEW">
127<emph>Year_start</emph> - An optional parameter that specifies the starting week of a year. </paragraph>
128<table id="tbl_id1173436">
129<tablerow>
130<tablecell colspan="" rowspan="">
131<paragraph role="tablehead" id="par_idN106FB" xml-lang="en-US" l10n="NEW">Year_start value</paragraph>
132</tablecell>
133<tablecell colspan="" rowspan="">
134<paragraph role="tablehead" id="par_idN10701" xml-lang="en-US" l10n="NEW">Explanation</paragraph>
135</tablecell>
136</tablerow>
137<tablerow>
138<tablecell colspan="" rowspan="">
139<paragraph role="tablecontent" id="par_idN10708" xml-lang="en-US" l10n="NEW">0</paragraph>
140</tablecell>
141<tablecell colspan="" rowspan="">
142<paragraph role="tablecontent" id="par_idN1070E" xml-lang="en-US" l10n="NEW">Use system default value</paragraph>
143</tablecell>
144</tablerow>
145<tablerow>
146<tablecell colspan="" rowspan="">
147<paragraph role="tablecontent" id="par_idN10715" xml-lang="en-US" l10n="NEW">1</paragraph>
148</tablecell>
149<tablecell colspan="" rowspan="">
150<paragraph role="tablecontent" id="par_idN1071B" xml-lang="en-US" l10n="NEW">Week 1 is the week with January, 1st (default)</paragraph>
151</tablecell>
152</tablerow>
153<tablerow>
154<tablecell colspan="" rowspan="">
155<paragraph role="tablecontent" id="par_idN10722" xml-lang="en-US" l10n="NEW">2</paragraph>
156</tablecell>
157<tablecell colspan="" rowspan="">
158<paragraph role="tablecontent" id="par_idN10728" xml-lang="en-US" l10n="NEW">Week 1 is the first week containing four or more days of that year</paragraph>
159</tablecell>
160</tablerow>
161<tablerow>
162<tablecell colspan="" rowspan="">
163<paragraph role="tablecontent" id="par_idN1072F" xml-lang="en-US" l10n="NEW">3</paragraph>
164</tablecell>
165<tablecell colspan="" rowspan="">
166<paragraph role="tablecontent" id="par_idN10735" xml-lang="en-US" l10n="NEW">Week 1 is the first week containing only days of the new year</paragraph>
167</tablecell>
168</tablerow>
169</table>
170</section>
171<paragraph role="heading" id="par_idN10738" xml-lang="en-US" level="2" l10n="NEW">Example:</paragraph>
172<paragraph role="code" id="par_idN1073C" xml-lang="en-US" l10n="NEW">Sub example_datediff</paragraph>
173<paragraph role="code" id="par_idN1073F" xml-lang="en-US" l10n="NEW">msgbox DateDiff("d", "1/1/2005", "12/31/2005")</paragraph>
174<paragraph role="code" id="par_idN10742" xml-lang="en-US" l10n="NEW">End Sub</paragraph>
175</body>
176</helpdocument>
177