ReadString$ - Learn To Code - PlayBASIC Documentation

ReadString$

String$ = ReadString$(ChannelIndex)

Parameters:

ChannelIndex = Index of the file channel to read from

Returns:

String$ = The string that has been read from this file

The ReadString$ function will read the next string from an open file channel.

The ReadString$ function expects to read strings that are terminated with a carriage return. This is perfect for reading individual lines of text from a text file created with notepad for example.

FACTS:

* ReadString$ only works with files opened with ReadFile command.
* ReadString$ expects the string it's loading to be terminated with a carriage return. ASC characters (10 & 13)

Mini Tutorial:

This example creates a simple file with some various bits of data store in it, then read it's back again.

  File$=TempDir$()+"PB_TestFile.txt"

; CReate a File for writing data to
  WriteFile File$,1

; Write a Byte to file channel 1, of value 200
  WriteByte 1,200

; Write a Word to file channel 1, of value 64000
  WriteWord 1,64000

; Write a INTEGER to file channel 1, of value 123456
  WriteInt 1,123456

; Write a FLOAT to file channel 1, of value 123.456
  WriteFloat 1,123.456

; Write a String to file channel 1, of value Hello World
  WriteString 1,"Hello Word"

; Close this file channel
  CloseFile 1


  Print "============================"
  Print "Reading File:"+File$
  Print "============================"


; Open a file to READ with READFILE
  ReadFile File$,1

; Read and display the byte value
  Print "   Byte Data:"+Str$(ReadByte(1))

; Read and display the word value
  Print "   Word Data:"+Str$(ReadWord(1))

; Read and display the Integer value
  Print "Integer Data:"+Str$(ReadInt(1))

; Read and display the Float value
  Print "  Float Data:"+Str$(ReadFloat(1))

; Read and display the String value
  Print "  String Data:"+ReadString$(1)

; Close this file channel
  CloseFile 1


  If FileExist(file$) Then DeleteFile file$

; Display the screen and wait for a key press
  Sync
  WaitKey

This example would output.

  ============================
  Reading File:C:Windows\temp\Pb_TestFile.txt
  ============================
  Byte Data:200
  Word Data:64000
  Integer Data:123456
  Float Data:123.456
  String Data:Hello World


Related Info:	CloseFile \| ReadByte \| ReadChr$ \| ReadChrAt$ \| ReadFile \| ReadFloat \| ReadInt \| ReadStringAt$ \| ReadValue \| ReadWord :