blob: 37f3d3999e79aafa39f207943f555c197de9de5f [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="textsbasicshared03020102xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">FreeFile Function[Runtime]</title>
<filename>/text/sbasic/shared/03020102.xhp</filename>
</topic>
</meta>
<body>
<section id="freefile">
<bookmark xml-lang="en-US" branch="index" id="bm_id3150400">
<bookmark_value>FreeFile function</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3150400" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03020102.xhp" name="FreeFile Function[Runtime]">FreeFile Function[Runtime]</link></paragraph>
<paragraph role="paragraph" id="par_id3154366" xml-lang="en-US" l10n="U">Returns the next available file number for opening a file. Use this function to open a file using a file number that is not already in use by a currently open file.</paragraph>
</section>
<paragraph role="heading" id="hd_id3150769" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
<paragraph role="code" id="par_id3150869" xml-lang="en-US" l10n="U">FreeFile</paragraph>
<paragraph role="heading" id="hd_id3151042" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
<paragraph role="paragraph" id="par_id3150440" xml-lang="en-US" l10n="U">Integer</paragraph>
<paragraph role="heading" id="hd_id3148576" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
<paragraph role="paragraph" id="par_id3155854" xml-lang="en-US" l10n="U">This function can only be used immediately in front of an Open statement. FreeFile returns the next available file number, but does not reserve it.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<embed href="text/sbasic/shared/00000003.xhp#err67"/>
<paragraph role="heading" id="hd_id3159153" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
<paragraph role="code" id="par_id3146120" xml-lang="en-US" l10n="U">Sub ExampleWorkWithAFile</paragraph>
<paragraph role="code" id="par_id3154319" xml-lang="en-US" l10n="U">Dim iNumber As Integer</paragraph>
<paragraph role="code" id="par_id3151117" xml-lang="en-US" l10n="U">Dim sLine As String</paragraph>
<paragraph role="code" id="par_id3147426" xml-lang="en-US" l10n="U">Dim aFile As String</paragraph>
<paragraph role="code" id="par_id3149667" xml-lang="en-US" l10n="U">Dim sMsg as String</paragraph>
<paragraph role="code" id="par_id3145800" xml-lang="en-US" l10n="U">aFile = "c:\data.txt"</paragraph>
<paragraph role="code" id="par_id3147396" xml-lang="en-US" l10n="CHG">sMsg = ""</paragraph>
<paragraph role="code" id="par_id3154490" xml-lang="en-US" l10n="U">iNumber = Freefile</paragraph>
<paragraph role="code" id="par_id3151074" xml-lang="en-US" l10n="U">Open aFile For Output As #iNumber</paragraph>
<paragraph role="code" id="par_id3155416" xml-lang="en-US" l10n="U">Print #iNumber, "First line of text"</paragraph>
<paragraph role="code" id="par_id3153416" xml-lang="en-US" l10n="U">Print #iNumber, "Another line of text"</paragraph>
<paragraph role="code" id="par_id3149401" xml-lang="en-US" l10n="U">Close #iNumber</paragraph>
<paragraph role="code" id="par_id3150330" xml-lang="en-US" l10n="U">iNumber = Freefile</paragraph>
<paragraph role="code" id="par_id3155067" xml-lang="en-US" l10n="U">Open aFile For Input As #iNumber</paragraph>
<paragraph role="code" id="par_id3155443" xml-lang="en-US" l10n="U">While not eof(#iNumber)</paragraph>
<paragraph role="code" id="par_id3153714" xml-lang="en-US" l10n="U">Line Input #iNumber, sLine</paragraph>
<paragraph role="code" id="par_id3148408" xml-lang="en-US" l10n="U">If sLine &lt;&gt;"" then</paragraph>
<paragraph role="code" id="par_id3156385" xml-lang="en-US" l10n="U">sMsg = sMsg &amp; sLine &amp; chr(13)</paragraph>
<paragraph role="code" id="par_id3145147" xml-lang="en-US" l10n="U">end if</paragraph>
<paragraph role="code" id="par_id3153966" xml-lang="en-US" l10n="U">wend</paragraph>
<paragraph role="code" id="par_id3155961" xml-lang="en-US" l10n="U">Close #iNumber</paragraph>
<paragraph role="code" id="par_id3149567" xml-lang="en-US" l10n="U">Msgbox sMsg</paragraph>
<paragraph role="code" id="par_id3146917" xml-lang="en-US" l10n="U">End Sub</paragraph>
</body>
</helpdocument>