summaryrefslogtreecommitdiff
path: root/helpcontent2/source/text/sbasic/shared/03030205.xhp
blob: f3114eb0aa9aa3de36dbbc81ed3f52811b5673a5 (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************************
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRUNTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc..
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************--><helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03030205xml" indexer="include" status="PUBLISH">
<title xml-lang="en-US" id="tit">TimeSerial Function [Runtime]</title>
<filename>/text/sbasic/shared/03030205.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2003-10-31T00:00:00">converted from old format - fpe</lastedited>
</history>
</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" oldref="1" l10n="U" xml-lang="en-US"><link href="text/sbasic/shared/03030205.xhp" name="TimeSerial Function [Runtime]">TimeSerial Function [Runtime]</link></paragraph>
  <paragraph role="paragraph" id="par_id3156344" l10n="U" xml-lang="en-US" oldref="2">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 role="heading" level="2" id="hd_id3146794" l10n="U" xml-lang="en-US" oldref="4">Syntax:</paragraph>
  <paragraph role="paragraph" id="par_id3150792" l10n="U" xml-lang="en-US" oldref="5">TimeSerial (hour, minute, second)</paragraph>
  <paragraph role="heading" level="2" id="hd_id3148797" l10n="U" xml-lang="en-US" oldref="6">Return value:</paragraph>
  <paragraph role="paragraph" id="par_id3154908" l10n="U" xml-lang="en-US" oldref="7">Date</paragraph>
  <paragraph role="heading" level="2" id="hd_id3154124" l10n="U" xml-lang="en-US" oldref="8">Parameters:</paragraph>
  <paragraph l10n="U" role="paragraph" id="par_id3153193" xml-lang="en-US" oldref="9"><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 l10n="U" role="paragraph" id="par_id3159252" xml-lang="en-US" oldref="10"><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 l10n="U" role="paragraph" id="par_id3161831" xml-lang="en-US" oldref="11"><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 l10n="U" role="paragraph" id="par_id3155854" xml-lang="en-US" oldref="12"><emph>Examples:</emph></paragraph>
  <paragraph role="paragraph" id="par_id3153952" l10n="U" xml-lang="en-US" oldref="13">12, -5, 45 corresponds to 11, 55, 45</paragraph>
  <paragraph role="paragraph" id="par_id3147349" l10n="U" xml-lang="en-US" oldref="14">12, 61, 45 corresponds to 13, 2, 45</paragraph>
  <paragraph role="paragraph" id="par_id3147426" l10n="U" xml-lang="en-US" oldref="15">12, 20, -2 corresponds to 12, 19, 58</paragraph>
  <paragraph role="paragraph" id="par_id3153365" l10n="U" xml-lang="en-US" oldref="16">12, 20, 63 corresponds to 12, 21, 4</paragraph>
  <paragraph role="paragraph" id="par_id3146985" l10n="U" xml-lang="en-US" oldref="17">You can use the TimeSerial function to convert any time into a single value that you can use to calculate time differences.</paragraph>
  <paragraph role="paragraph" id="par_id3155308" l10n="U" xml-lang="en-US" oldref="18">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 role="paragraph" id="par_id3149482" l10n="U" xml-lang="en-US" oldref="19">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 role="heading" level="2" id="hd_id3154790" l10n="U" xml-lang="en-US" oldref="20">Example:</paragraph>
  <paragraph role="paragraph" id="par_id3145252" l10n="U" xml-lang="en-US" oldref="21">Sub ExampleTimeSerial</paragraph>
  <paragraph role="paragraph" id="par_id3153157" l10n="U" xml-lang="en-US" oldref="22">Dim dDate As Double, sDate As String</paragraph>
  <paragraph role="paragraph" id="par_id3156286" l10n="U" xml-lang="en-US" oldref="23">dDate = TimeSerial(8,30,15)</paragraph>
  <paragraph role="paragraph" id="par_id3148456" l10n="U" xml-lang="en-US" oldref="24">sDate = TimeSerial(8,30,15)</paragraph>
  <paragraph role="paragraph" id="par_id3155600" l10n="U" xml-lang="en-US" oldref="25">MsgBox dDate,64,&quot;Time as a number&quot;</paragraph>
  <paragraph role="paragraph" id="par_id3153417" l10n="U" xml-lang="en-US" oldref="26">MsgBox sDate,64,&quot;Formatted time&quot;</paragraph>
  <paragraph role="paragraph" id="par_id3153836" l10n="U" xml-lang="en-US" oldref="27">End Sub</paragraph>
 </body>
</helpdocument>