1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--***********************************************************
4 *
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements.  See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership.  The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License.  You may obtain a copy of the License at
12 *
13 *   http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied.  See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 *
22 ***********************************************************-->
23
24<helpdocument version="1.0">
25<meta>
26<topic id="textsbasicshared03020302xml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">Loc Function [Runtime]</title>
28<filename>/text/sbasic/shared/03020302.xhp</filename>
29</topic>
30</meta>
31<body>
32<section id="loc">
33<bookmark xml-lang="en-US" branch="index" id="bm_id3148663">
34<bookmark_value>Loc function</bookmark_value>
35</bookmark>
36<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>
37<paragraph role="paragraph" id="par_id3154138" xml-lang="en-US" l10n="U">Returns the current position in an open file.</paragraph>
38</section>
39<paragraph role="heading" id="hd_id3156422" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
40<paragraph role="code" id="par_id3150768" xml-lang="en-US" l10n="U">Loc(FileNumber)</paragraph>
41<paragraph role="heading" id="hd_id3150440" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
42<paragraph role="paragraph" id="par_id3152578" xml-lang="en-US" l10n="U">Long</paragraph>
43<paragraph role="heading" id="hd_id3152462" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
44<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>
45<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>
46<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>
47<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
48<embed href="text/sbasic/shared/00000003.xhp#err5"/>
49<embed href="text/sbasic/shared/00000003.xhp#err52"/>
50</body>
51</helpdocument>
52