summaryrefslogtreecommitdiff
path: root/source/text/sbasic/shared/03030205.xhp
blob: ce4460608375222e582c5c0671f2d2428fe85580 (plain)
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
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->

<meta>
  <topic id="textsbasicshared03030205xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">TimeSerial Function</title>
    <filename>/text/sbasic/shared/03030205.xhp</filename>
  </topic>
</meta>

<body>


<section id="timeserial">
<bookmark xml-lang="en-US" branch="index" id="bm_id3143271">
  <bookmark_value>TimeSerial function</bookmark_value>
</bookmark>


<paragraph id="hd_id3143271" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030205.xhp" name="TimeSerial Function">TimeSerial Function</link></paragraph>
<paragraph id="par_id3156344" role="paragraph" xml-lang="en-US">Calculates a serial time value for the specified hour, minute, and second parameters that are passed as numeric value. You can then use this value to calculate the difference between times.</paragraph>
</section>

<paragraph id="hd_id3146794" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3150792" localize="false" role="bascode">TimeSerial (Hour, Minute, Second)</paragraph>
</bascode>

<paragraph id="hd_id3148797" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
<paragraph id="par_id3154908" role="paragraph" xml-lang="en-US">Date</paragraph>

<paragraph id="hd_id3154124" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>hour:</emph> Any integer expression that indicates the hour of the time that is used to determine the serial time value. Valid values: 0-23.</paragraph>
<paragraph id="par_id3159252" role="paragraph" xml-lang="en-US"> <emph>minute:</emph> Any integer expression that indicates the minute of the time that is used to determine the serial time value. In general, use values between 0 and 59. However, you can also use values that lie outside of this range, where the number of minutes influence the hour value.</paragraph>
<paragraph id="par_id3161831" role="paragraph" xml-lang="en-US"> <emph>second:</emph> Any integer expression that indicates the second of the time that is used to determine the serial time value. In general, you can use values between 0 and 59. However, you can also use values that lie outside of this range, where the number seconds influences the minute value.</paragraph>
<paragraph id="par_id3155854" role="paragraph" xml-lang="en-US"> <emph>Examples:</emph> </paragraph>
<paragraph id="par_id3153952" role="paragraph" xml-lang="en-US">12, -5, 45 corresponds to 11, 55, 45</paragraph>
<paragraph id="par_id3147349" role="paragraph" xml-lang="en-US">12, 61, 45 corresponds to 13, 2, 45</paragraph>
<paragraph id="par_id3147426" role="paragraph" xml-lang="en-US">12, 20, -2 corresponds to 12, 19, 58</paragraph>
<paragraph id="par_id3153365" role="paragraph" xml-lang="en-US">12, 20, 63 corresponds to 12, 21, 4</paragraph>
<paragraph id="par_id3146985" role="paragraph" xml-lang="en-US">You can use the TimeSerial function to convert any time into a single value that you can use to calculate time differences.</paragraph>
<paragraph id="par_id3155308" role="paragraph" xml-lang="en-US">The TimeSerial function returns the type Variant with VarType 7 (Date). This value is stored internally as a double-precision number between 0 and 0.9999999999. As opposed to the DateSerial or DateValue function, where the serial date values are calculated as days relative to a fixed date, you can calculate with values returned by the TimeSerial function, but you cannot evaluate them.</paragraph>
<paragraph id="par_id3149482" role="paragraph" xml-lang="en-US">In the TimeValue function, you can pass a string as a parameter containing the time. For the TimeSerial function, however, you can pass the individual parameters (hour, minute, second) as separate numeric expressions.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>

<paragraph id="hd_id3154790" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1341318224" role="bascode" localize="false" xml-lang="en-US">Sub ExampleTimeSerial</paragraph>
<paragraph id="par_idm1341316992" role="bascode" localize="false" xml-lang="en-US">Dim dDate As Double, sDate As String</paragraph>
<paragraph id="par_idm1341315744" role="bascode" localize="false" xml-lang="en-US">    dDate = TimeSerial(8,30,15)</paragraph>
<paragraph id="par_idm1341314496" role="bascode" localize="false" xml-lang="en-US">    sDate = TimeSerial(8,30,15)</paragraph>
<paragraph id="par_id3155600" role="bascode" xml-lang="en-US">    MsgBox dDate,64,"Time as a number"</paragraph>
<paragraph id="par_id3153417" role="bascode" xml-lang="en-US">    MsgBox sDate,64,"Formatted time"</paragraph>
<paragraph id="par_idm1341309792" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>

</helpdocument>