xref: /AOO42X/main/helpcontent2/source/text/sbasic/shared/03030206.xhp (revision da39209ec3b2294604e1120a772843de9095355b)
1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3d33d0967SAndrew Rist<!--***********************************************************
4cdf0e10cSrcweir *
5d33d0967SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
6d33d0967SAndrew Rist * or more contributor license agreements.  See the NOTICE file
7d33d0967SAndrew Rist * distributed with this work for additional information
8d33d0967SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
9d33d0967SAndrew Rist * to you under the Apache License, Version 2.0 (the
10d33d0967SAndrew Rist * "License"); you may not use this file except in compliance
11d33d0967SAndrew Rist * with the License.  You may obtain a copy of the License at
12cdf0e10cSrcweir *
13d33d0967SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
14cdf0e10cSrcweir *
15d33d0967SAndrew Rist * Unless required by applicable law or agreed to in writing,
16d33d0967SAndrew Rist * software distributed under the License is distributed on an
17d33d0967SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18d33d0967SAndrew Rist * KIND, either express or implied.  See the License for the
19d33d0967SAndrew Rist * specific language governing permissions and limitations
20d33d0967SAndrew Rist * under the License.
21cdf0e10cSrcweir *
22d33d0967SAndrew Rist ***********************************************************-->
23d33d0967SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03030206xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">TimeValue Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03030206.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="timevalue">
335b00253eSmseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3149670">
345b00253eSmseidel<bookmark_value>TimeValue function</bookmark_value>
35cdf0e10cSrcweir</bookmark>
36*da39209eSmseidel<paragraph role="heading" id="hd_id3149670" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03030206.xhp" name="TimeValue Function [Runtime]">TimeValue Function [Runtime]</link></paragraph>
37*da39209eSmseidel<paragraph role="paragraph" id="par_id3153361" xml-lang="en-US" l10n="U">Calculates a serial time value from the specified hour, minute, and second - parameters passed as strings - that represents the time in a single numeric value. This value can be used to calculate the difference between times.</paragraph>
38cdf0e10cSrcweir</section>
39*da39209eSmseidel<paragraph role="heading" id="hd_id3154138" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
40*da39209eSmseidel<paragraph role="paragraph" id="par_id3156282" xml-lang="en-US" l10n="U">TimeValue (Text As String)</paragraph>
41*da39209eSmseidel<paragraph role="heading" id="hd_id3153969" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
42*da39209eSmseidel<paragraph role="paragraph" id="par_id3156424" xml-lang="en-US" l10n="U">Date</paragraph>
43*da39209eSmseidel<paragraph role="heading" id="hd_id3145172" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
44*da39209eSmseidel<paragraph role="paragraph" id="par_id3145786" xml-lang="en-US" l10n="U"><emph>Text:</emph> Any string expression that contains the time that you want to calculate in the format "HH:MM:SS".</paragraph>
45*da39209eSmseidel<paragraph role="paragraph" id="par_id3152578" xml-lang="en-US" l10n="U">Use the TimeValue function to convert any time into a single value, so that you can calculate time differences.</paragraph>
46*da39209eSmseidel<paragraph role="paragraph" id="par_id3163710" xml-lang="en-US" l10n="U">This TimeValue function returns the type Variant with VarType 7 (Date), and stores this value internally as a double-precision number between 0 and 0.9999999999.</paragraph>
47*da39209eSmseidel<paragraph role="paragraph" id="par_id3151117" xml-lang="en-US" l10n="U">As opposed to the DateSerial or the DateValue function, where serial date values result in days relative to a fixed date, you can calculate with the values that are returned by the TimeValue function, but you cannot evaluate them.</paragraph>
48*da39209eSmseidel<paragraph role="paragraph" id="par_id3147426" xml-lang="en-US" l10n="U">In the TimeSerial function, you can pass individual parameters (hour, minute, second) as separate numeric expressions. For the TimeValue function, however, you can pass a string as a parameter containing the time.</paragraph>
49cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
50cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
51cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err13"/>
52*da39209eSmseidel<paragraph role="heading" id="hd_id3145271" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
53*da39209eSmseidel<paragraph role="paragraph" id="par_id3152597" xml-lang="en-US" l10n="U">Sub ExampleTimerValue</paragraph>
54*da39209eSmseidel<paragraph role="paragraph" id="par_id3147348" xml-lang="en-US" l10n="U">Dim daDT as Date</paragraph>
55*da39209eSmseidel<paragraph role="paragraph" id="par_id3148576" xml-lang="en-US" l10n="U">Dim a1, b1, c1, a2, b2, c2 as String</paragraph>
56*da39209eSmseidel<paragraph role="paragraph" id="par_id3149378" xml-lang="en-US" l10n="U">a1 = "start time"</paragraph>
57*da39209eSmseidel<paragraph role="paragraph" id="par_id3145800" xml-lang="en-US" l10n="U">b1 = "end time"</paragraph>
58*da39209eSmseidel<paragraph role="paragraph" id="par_id3151074" xml-lang="en-US" l10n="U">c1 = "total time"</paragraph>
59*da39209eSmseidel<paragraph role="paragraph" id="par_id3154492" xml-lang="en-US" l10n="U">a2 = "8:34"</paragraph>
60*da39209eSmseidel<paragraph role="paragraph" id="par_id3155602" xml-lang="en-US" l10n="U">b2 = "18:12"</paragraph>
61*da39209eSmseidel<paragraph role="paragraph" id="par_id3150715" xml-lang="en-US" l10n="U">daDT = TimeValue(b2) - TimeValue(a2)</paragraph>
62*da39209eSmseidel<paragraph role="paragraph" id="par_id3153838" xml-lang="en-US" l10n="U">c2 = a1 &amp; ": " &amp; a2 &amp; chr(13)</paragraph>
63*da39209eSmseidel<paragraph role="paragraph" id="par_id3150749" xml-lang="en-US" l10n="U">c2 = c2 &amp; b1 &amp; ": " &amp; b2 &amp; chr(13)</paragraph>
64*da39209eSmseidel<paragraph role="paragraph" id="par_id3154755" xml-lang="en-US" l10n="U">c2 = c2 &amp; c1 &amp; ": " &amp; trim(Str(Hour(daDT))) &amp; ":" &amp; trim(Str(Minute(daDT))) &amp; ":" &amp; trim(Str(Second(daDT)))</paragraph>
65*da39209eSmseidel<paragraph role="paragraph" id="par_id3153714" xml-lang="en-US" l10n="U">Msgbox c2</paragraph>
66*da39209eSmseidel<paragraph role="paragraph" id="par_id3155767" xml-lang="en-US" l10n="U">end sub</paragraph>
67cdf0e10cSrcweir</body>
68cdf0e10cSrcweir</helpdocument>
69