blob: 18071d35fefd600c550cc7f524dcb3bd796c7595 [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="textsbasicshared03020202xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Input# Statement [Runtime]</title>
<filename>/text/sbasic/shared/03020202.xhp</filename>
</topic>
</meta>
<body>
<section id="input">
<bookmark xml-lang="en-US" branch="index" id="bm_id3154908">
<bookmark_value>Input statement</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3154908" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03020202.xhp" name="Input# Statement [Runtime]">Input# Statement [Runtime]</link></paragraph>
<paragraph role="paragraph" id="par_id3156424" xml-lang="en-US" l10n="U">Reads data from an open sequential file.</paragraph>
</section>
<paragraph role="heading" id="hd_id3125863" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
<paragraph role="code" id="par_id3150440" xml-lang="en-US" l10n="U">Input #FileNumber As Integer; var1[, var2[, var3[,...]]]</paragraph>
<paragraph role="heading" id="hd_id3146121" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
<paragraph role="paragraph" id="par_id3145749" xml-lang="en-US" l10n="U"><emph>FileNumber:</emph> Number of the file that contains the data that you want to read. The file must be opened with the Open statement using the key word INPUT.</paragraph>
<paragraph role="paragraph" id="par_id3150011" xml-lang="en-US" l10n="U"><emph>var:</emph> A numeric or string variable that you assign the values read from the opened file to.</paragraph>
<paragraph role="paragraph" id="par_id3159153" xml-lang="en-US" l10n="U">The <emph>Input#</emph> statement reads numeric values or strings from an open file and assigns the data to one or more variables. A numeric variable is read up to the first carriage return (Asc=13), line feed (Asc=10), space, or comma. String variables are read to up to the first carriage return (Asc=13), line feed (Asc=10), or comma.</paragraph>
<paragraph role="paragraph" id="par_id3146984" xml-lang="en-US" l10n="U">Data and data types in the opened file must appear in the same order as the variables that are passed in the "var" parameter. If you assign non-numeric values to a numeric variable, "var" is assigned a value of "0".</paragraph>
<paragraph role="paragraph" id="par_id3156442" xml-lang="en-US" l10n="CHG">Records that are separated by commas cannot be assigned to a string variable. Quotation marks (") in the file are disregarded as well. If you want to read these characters from the file, use the <emph>Line Input#</emph> statement to read pure text files (files containing only printable characters) line by line.</paragraph>
<paragraph role="paragraph" id="par_id3147349" xml-lang="en-US" l10n="U">If the end of the file is reached while reading a data element, an error occurs and the process is aborted.</paragraph>
<paragraph role="heading" id="hd_id3152578" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
<paragraph role="code" id="par_id3144765" xml-lang="en-US" l10n="U">Sub ExampleWorkWithAFile</paragraph>
<paragraph role="code" id="par_id3145799" xml-lang="en-US" l10n="U">Dim iNumber As Integer</paragraph>
<paragraph role="code" id="par_id3145252" xml-lang="en-US" l10n="U">Dim sLine As String</paragraph>
<paragraph role="code" id="par_id3149410" xml-lang="en-US" l10n="U">Dim aFile As String</paragraph>
<paragraph role="code" id="par_id3149959" xml-lang="en-US" l10n="U">Dim sMsg as String</paragraph>
<paragraph role="code" id="par_id3153417" xml-lang="en-US" l10n="U">aFile = "c:\data.txt"</paragraph>
<paragraph role="code" id="par_id3150752" xml-lang="en-US" l10n="U">iNumber = Freefile</paragraph>
<paragraph role="code" id="par_id3153707" xml-lang="en-US" l10n="U">Open aFile For Output As #iNumber</paragraph>
<paragraph role="code" id="par_id3150321" xml-lang="en-US" l10n="U">Print #iNumber, "This is a line of text"</paragraph>
<paragraph role="code" id="par_id3154756" xml-lang="en-US" l10n="U">Print #iNumber, "This is another line of text"</paragraph>
<paragraph role="code" id="par_id3148408" xml-lang="en-US" l10n="U">Close #iNumber</paragraph>
<paragraph role="code" id="par_id3155937" xml-lang="en-US" l10n="U">iNumber = Freefile</paragraph>
<paragraph role="code" id="par_id3154702" xml-lang="en-US" l10n="U">Open aFile For Input As iNumber</paragraph>
<paragraph role="code" id="par_id3155959" xml-lang="en-US" l10n="U">While not eof(iNumber)</paragraph>
<paragraph role="code" id="par_id3145232" xml-lang="en-US" l10n="U">Line Input #iNumber, sLine<comment>This is a LINE INPUT# example, not for INPUT#</comment></paragraph>
<paragraph role="code" id="par_id3147345" xml-lang="en-US" l10n="U">If sLine &lt;&gt;"" then</paragraph>
<paragraph role="code" id="par_id3150298" xml-lang="en-US" l10n="U">sMsg = sMsg &amp; sLine &amp; chr(13)</paragraph>
<paragraph role="code" id="par_id3154021" xml-lang="en-US" l10n="U">end if</paragraph>
<paragraph role="code" id="par_id3154665" xml-lang="en-US" l10n="U">wend</paragraph>
<paragraph role="code" id="par_id3155607" xml-lang="en-US" l10n="U">Close #iNumber</paragraph>
<paragraph role="code" id="par_id3153268" xml-lang="en-US" l10n="U">Msgbox sMsg</paragraph>
<paragraph role="code" id="par_id3152584" xml-lang="en-US" l10n="CHG">End Sub</paragraph>
</body>
</helpdocument>