Objeck Documentation

All Bundles

FileReaderWriter

Supports file read and write operations

Operations

New
Close
ReadBinaryFile
ReadBuffer
ReadByte
ReadFile
ReadLine
Temp
WriteBuffer
WriteByte
WriteFile
WriteString

Close

Closes the file

method : public : Close() ~ Nil

New

Default constructor.

New(name:System.String)

Parameters

Name	Type	Description
name	String	filename

ReadBinaryFile

Reads a file's contents into byte array

function : ReadBinaryFile(name:String) ~ Byte[]

Parameters

Name	Type	Description
name	String	filename

Return

Type	Description
Byte	byte array, Nil if file is not found

ReadBuffer

Reads bytes into a character buffer

method : public : ReadBuffer(offset:Int, num:Int, buffer:Char[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to read
buffer	Char	input buffer

Return

Type	Description
Int	number of values read

ReadBuffer

Reads bytes into a byte buffer

method : public : ReadBuffer(offset:Int, num:Int, buffer:Byte[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to read
buffer	Byte	input buffer

Return

Type	Description
Int	number of values read

ReadByte

Reads a byte

method : public : ReadByte() ~ Byte

Return

Type	Description
Byte	byte read

ReadFile

Reads a file's contents into a string

function : ReadFile(name:String) ~ String

Parameters

Name	Type	Description
name	String	filename

Return

Type	Description
String	character string, Nil if file is not found

ReadLine

Reads a string until a newline or character return is detected

method : public : ReadLine() ~ System.String

Return

Type	Description
String	character string

Temp

Creates a temporary file

function : Temp() ~ FileWriter

WriteBuffer

Writes bytes from a buffer

method : public : WriteBuffer(buffer:Byte[]) ~ Int

Parameters

Name	Type	Description
buffer	Byte	output buffer

Return

Type	Description
Int	true if successful, false otherwise

WriteBuffer

Writes bytes from a buffer

method : public : WriteBuffer(offset:Int, num:Int, buffer:Byte[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to write
buffer	Byte	output buffer

Return

Type	Description
Int	number of values written

WriteBuffer

Writes characters from a buffer

method : public : WriteBuffer(buffer:Char[]) ~ Int

Parameters

Name	Type	Description
buffer	Char	output buffer

Return

Type	Description
Int	true if successful, false otherwise

WriteBuffer

Writes characters from a buffer

method : public : WriteBuffer(offset:Int, num:Int, buffer:Char[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to write
buffer	Char	input buffer

Return

Type	Description
Int	number of values written

WriteByte

Writes a byte

method : public : WriteByte(b:Int) ~ Bool

Parameters

Name	Type	Description
b	Int	byte to write

Return

Type	Description
Bool	true if byte was written, false otherwise

WriteFile

Write string to file

function : WriteFile(name:String, content:String) ~ Bool

Parameters

Name	Type	Description
name	String	filename
content	String	string to write

Return

Type	Description
Bool	true if successful, false otherwise

WriteFile

Write bytes to file

function : WriteFile(name:String, content:Byte[]) ~ Bool

Parameters

Name	Type	Description
name	String	filename
content	Byte	to write

Return

Type	Description
Bool	true if successful, false otherwise

WriteString

Writes a character string

method : public : WriteString(str:System.String) ~ Nil

Parameters

Name	Type	Description
str	String	string to be written