blob: 168a925bbf38f109dd698b0b17f7cba72cfb875d [file]
<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
***********************************************************-->
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03030201xml" indexer="include" status="PUBLISH">
<title xml-lang="en-US" id="tit">Hour Function [Runtime]</title>
<filename>/text/sbasic/shared/03030201.xhp</filename>
</topic>
</meta>
<body>
<section id="hour">
<bookmark xml-lang="en-US" branch="index" id="bm_id3156042">
<bookmark_value>Hour function</bookmark_value>
</bookmark>
<paragraph xml-lang="en-US" id="hd_id3156042" role="heading" level="1" l10n="U"><link href="text/sbasic/shared/03030201.xhp" name="Hour Function [Runtime]">Hour Function [Runtime]</link></paragraph>
<paragraph xml-lang="en-US" id="par_id3149346" role="paragraph" l10n="U">Returns the hour from a time value that is generated by the TimeSerial or the TimeValue function.</paragraph>
</section>
<paragraph xml-lang="en-US" id="hd_id3147574" role="heading" level="2" l10n="U">Syntax:</paragraph>
<paragraph xml-lang="en-US" id="par_id3147264" role="paragraph" l10n="U">Hour (Number)</paragraph>
<paragraph xml-lang="en-US" id="hd_id3145069" role="heading" level="2" l10n="U">Return value:</paragraph>
<paragraph xml-lang="en-US" id="par_id3149670" role="paragraph" l10n="U">Integer</paragraph>
<paragraph xml-lang="en-US" id="hd_id3150359" role="heading" level="2" l10n="U">Parameters:</paragraph>
<paragraph xml-lang="en-US" id="par_id3154366" role="paragraph" l10n="U"><emph>Number:</emph> Numeric expression that contains the serial time value that is used to return the hour value.</paragraph>
<paragraph xml-lang="en-US" id="par_id3154909" role="paragraph" l10n="U">This function is the opposite of the <emph>TimeSerial</emph> function. It returns an integer value that represents the hour from a time value that is generated by the <emph>TimeSerial</emph> or the <emph>TimeValue</emph> function. For example, the expression</paragraph>
<paragraph xml-lang="en-US" id="par_id3163798" role="paragraph" l10n="CHG">Print Hour(TimeSerial(12,30,41))</paragraph>
<paragraph xml-lang="en-US" id="par_id3155132" role="paragraph" l10n="U">returns the value 12.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<paragraph xml-lang="en-US" id="hd_id3147348" role="heading" level="2" l10n="U">Example:</paragraph>
<paragraph xml-lang="en-US" id="par_id3146985" role="paragraph" l10n="U">Sub ExampleHour</paragraph>
<paragraph xml-lang="en-US" id="par_id3156441" role="paragraph" l10n="U">Print "The current hour is " &amp; Hour( Now )</paragraph>
<paragraph xml-lang="en-US" id="par_id3153145" role="paragraph" l10n="U">End Sub</paragraph>
</body>
</helpdocument>