blob: 012d0d3d2b909eb9c90bc06ee97841e7a5016205 [file] [log] [blame]
<?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="textsbasicshared03020302xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Loc Function [Runtime]</title>
<filename>/text/sbasic/shared/03020302.xhp</filename>
</topic>
</meta>
<body>
<section id="loc">
<bookmark xml-lang="en-US" branch="index" id="bm_id3148663">
<bookmark_value>Loc function</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3148663" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03020302.xhp" name="Loc Function [Runtime]">Loc Function [Runtime]</link></paragraph>
<paragraph role="paragraph" id="par_id3154138" xml-lang="en-US" l10n="U">Returns the current position in an open file.</paragraph>
</section>
<paragraph role="heading" id="hd_id3156422" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
<paragraph role="code" id="par_id3150768" xml-lang="en-US" l10n="U">Loc(FileNumber)</paragraph>
<paragraph role="heading" id="hd_id3150440" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
<paragraph role="paragraph" id="par_id3152578" xml-lang="en-US" l10n="U">Long</paragraph>
<paragraph role="heading" id="hd_id3152462" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
<paragraph role="paragraph" id="par_id3153363" xml-lang="en-US" l10n="U"><emph>FileNumber:</emph> Any numeric expression that contains the file number that is set by the Open statement for the respective file.</paragraph>
<paragraph role="paragraph" id="par_id3154320" xml-lang="en-US" l10n="U">If the Loc function is used for an open random access file, it returns the number of the last record that was last read or written.</paragraph>
<paragraph role="paragraph" id="par_id3151115" xml-lang="en-US" l10n="U">For a sequential file, the Loc function returns the position in a file divided by 128. For binary files, the position of the last read or written byte is returned.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<embed href="text/sbasic/shared/00000003.xhp#err52"/>
</body>
</helpdocument>