blob: 7b7786221d2735dd63712cf87db43288a84f0055 [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="textsbasicshared03020408xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">FileLen-Function [Runtime]</title>
<filename>/text/sbasic/shared/03020408.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2004-09-01T15:28:40">converted from old format - fpe</lastedited>
</history>
</meta>
<body>
<section id="filelen">
<bookmark xml-lang="en-US" branch="index" id="bm_id3153126"><bookmark_value>FileLen function</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3153126" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03020408.xhp" name="FileLen-Function [Runtime]">FileLen Function [Runtime]</link></paragraph>
<paragraph role="paragraph" id="par_id3145068" xml-lang="en-US" l10n="U" oldref="2">Returns the length of a file in bytes.</paragraph>
</section>
<paragraph role="heading" id="hd_id3159414" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
<paragraph role="code" id="par_id3149656" xml-lang="en-US" l10n="U" oldref="4">FileLen (Text As String)</paragraph>
<paragraph role="heading" id="hd_id3148798" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
<paragraph role="paragraph" id="par_id3156282" xml-lang="en-US" l10n="U" oldref="6">Long</paragraph>
<paragraph role="heading" id="hd_id3150768" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph>
<paragraph role="paragraph" id="par_id3153193" xml-lang="en-US" l10n="U" oldref="8">
<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 role="paragraph" id="par_id3150439" xml-lang="en-US" l10n="U" oldref="9">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 role="heading" id="hd_id3163710" xml-lang="en-US" level="2" l10n="U" oldref="10">Example:</paragraph>
<paragraph role="code" id="par_id3159154" xml-lang="en-US" l10n="U" oldref="11">Sub ExampleFileLen</paragraph>
<paragraph role="code" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="12">msgbox FileLen("C:\autoexec.bat")</paragraph>
<paragraph role="code" id="par_id3145749" xml-lang="en-US" l10n="U" oldref="13">end sub</paragraph>
</body>
</helpdocument>