func_streams_readline.rst 604 B

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. .. _func_streams_readline:
  2. ========
  3. ReadLine
  4. ========
  5. ReadLine -
  6. Description
  7. ===========
  8. .. code-block:: blitzmax
  9. ReadLine$( stream:TStream )
  10. Read a line of text from a stream
  11. Bytes are read from @stream until a newline character (ascii code 10) or null
  12. character (ascii code 0) is read, or end of file is detected.
  13. Carriage Return characters (ascii code 13) are silently ignored.
  14. The bytes read are returned in the form of a string, excluding any terminating newline
  15. or null character.
  16. Parameters
  17. ==========
  18. Return Values
  19. =============
  20. A string
  21. Examples
  22. ========
  23. See Also
  24. ========