Whitebeam Object Definition

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Object Definition

Method Description

Binary.read()

Read 'n' octets from an open file or directory

Syntax

Binary = Binary.read(octetsToRead)

Parameters

The 'Binary.read' method takes 1 parameter:

Name Type/Value Range/Length Description
octetsToReadnumber  Required. Number of octets to be read from the currently open file or directory.

Results

The 'Binary.read' method returns Binary:

Type/Value Range/Length Description
Binary  

Remarks

Attempt to read the specified number of bytes from an open file or directory associated with this Binary object. If there is no open file an exception is thrown.

The effect of making this call is that the Binary object will contain the block that has been read - discarding any previous contents. This means that obj.length will return the number of octets actually read.

This method returns a reference to the Binary object

Whitebeam release 1.3.36
(loadtime : 27ms)