summaryrefslogtreecommitdiff
path: root/source/text/sbasic/shared/03020408.xhp
blob: e4ffbee49b43bd3a3db4536c468a215e0134b7e7 (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
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
-->

<meta>
  <topic id="textsbasicshared03020408xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">FileLen Function [Runtime]</title>
    <filename>/text/sbasic/shared/03020408.xhp</filename>
  </topic>
</meta>

<body>


<section id="filelen">
<bookmark xml-lang="en-US" branch="index" id="bm_id3153126">
  <bookmark_value>FileLen function</bookmark_value>
</bookmark>


<paragraph id="hd_id3153126" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020408.xhp" name="FileLen Function [Runtime]">FileLen Function [Runtime]</link></paragraph>
<paragraph id="par_id3145068" role="paragraph" xml-lang="en-US">Returns the length of a file in bytes.</paragraph>
</section>

<paragraph id="hd_id3159414" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3149656" role="bascode" xml-lang="en-US">FileLen (Text As String)</paragraph>
</bascode>

<paragraph id="hd_id3148798" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
<paragraph id="par_id3156282" role="paragraph" xml-lang="en-US">Long</paragraph>

<paragraph id="hd_id3150768" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that contains an unambiguous file specification. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph>
<paragraph id="par_id3150439" role="paragraph" xml-lang="en-US">This function determines the length of a file. If the FileLen function is called for an open file, it returns the file length before it was opened. To determine the current file length of an open file, use the Lof function.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>

<paragraph id="hd_id3163710" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1341573440" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFileLen</paragraph>
<paragraph id="par_idm1341572208" role="bascode" localize="false" xml-lang="en-US">    MsgBox FileLen("C:\autoexec.bat")</paragraph>
<paragraph id="par_idm1341570960" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>

</helpdocument>