FileSystem.LineInput(Int32) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Reads a single line from an open sequential file and assigns it to a String
variable.
public:
static System::String ^ LineInput(int FileNumber);
public static string LineInput (int FileNumber);
static member LineInput : int -> string
Public Function LineInput (FileNumber As Integer) As String
Parameters
- FileNumber
- Int32
Required. Any valid file number.
Returns
Reads a single line from an open sequential file and assigns it to a String
variable.
Exceptions
End of file reached.
FileNumber
does not exist.
Examples
This example uses the LineInput
function to read a line from a sequential file and assign it to a variable. This example assumes that TestFile
is a text file that has several lines of sample data.
Dim TextLine As String
' Open file.
FileOpen(1, "TESTFILE", OpenMode.Input)
' Loop until end of file.
While Not EOF(1)
' Read line into variable.
TextLine = LineInput(1)
' Print to the console.
Console.WriteLine("1", TextLine)
End While
FileClose(1)
Remarks
The LineInput
function is provided for backward compatibility and may affect performance. For non-legacy applications, the My.Computer.FileSystem
object provides better performance. For more information, see File Access with Visual Basic.
Data read with LineInput
is usually written to a file by using Print
.
Important
When reading from files, do not make decisions about the contents of a file based on the file name extension. For example, a file that is named Form1.vb may not be a Visual Basic source file.
The LineInput
function reads from a file one character at a time until it encounters a carriage return (Chr(13)
) or carriage return/line feed (Chr(13) + Chr(10)
) sequence. Carriage return/line feed sequences are skipped instead of appended to the character string.
Important
Reading from a file by using the LineInput
function requires Read
access from the FileIOPermissionAccess enumeration.