Difference between revisions of "File.streamout"

From OpenEUO
Jump to: navigation, search
(Created page with "== Calling Pattern == Call local f = sl.file(a,b) local r = f.streamout(c) Argument c is a string Results r is a string == Description == The streamout method writes the...")
 
m (Description)
 
(One intermediate revision by the same user not shown)
Line 9: Line 9:
  
 
Results
 
Results
  r is a string
+
  r is a boolean
  
 
== Description ==
 
== Description ==
  
The streamout method writes the raw (binary) contents of a string from the current cursor position to the file and updates the current position.   
+
The streamout method writes the raw (binary) contents of a string from the current cursor position to the file and updates the current position.  Streamout returns true if the write is successful.
  
 
== Upon Error ==
 
== Upon Error ==

Latest revision as of 16:21, 18 December 2010

Calling Pattern

Call

local f = sl.file(a,b)
local r = f.streamout(c)

Argument

c is a string

Results

r is a boolean

Description

The streamout method writes the raw (binary) contents of a string from the current cursor position to the file and updates the current position. Streamout returns true if the write is successful.

Upon Error

Streamout returns false if the file handling object is finalized or the underlying file is otherwise unopened, opened in read mode, or if structured data has been written to the file. Any other error will be handled according to the operant error redirection mode.

See Also