Class Fox::FXFileStream
In: rdoc-sources/FXFileStream.rb
lib/fox16/iterators.rb
Parent: FXStream

File Store Definition

Methods

new   open   open  

Attributes

position  [R] 

Public Class methods

new(cont=nil) {|theFileStream| ...}

Return an initialized FXFileStream instance.

open(filename, save_or_load, size=8192, container=nil) {|theFileStream| ...}

Construct a new FXFileStream object with the specified data flow direction (save_or_load) and container object. If an optional code block is given, it will be passed this file stream as an argument, and the file stream will automatically be closed when the block terminates. If no code block is provided, this method just returns the new file stream in an opened state.

Raises FXStreamNoWriteError if save_or_load is FXStreamSave but the file cannot be opened for writing. Raises FXStreamNoReadError if save_or_load is FXStreamLoad but the file cannot be opened for reading.

Public Instance methods

open(filename, save_or_load, size=8192)

Open binary data file stream; allocate a buffer of the given size for the file I/O; the buffer must be at least 16 bytes. Returns true on success, false on failure.

Parameters:

filename:name of the file to open [String]
save_or_load:access mode, either FXStreamSave or FXStreamLoad [Integer]
size:buffer size [Integer]

[Validate]