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.load()

Load the contents of a file into the binary object.

Syntax

bool = Binary.load(filename)

Parameters

The 'Binary.load' method takes 1 parameter:

Name Type/Value Range/Length Description
filenamestring  Optional. The optional filename to load. This method requires a filename in order to work. The filename may either have been set through Binary.fname() or must be set in this call.

Results

The 'Binary.load' method returns bool:

Type/Value Range/Length Description
bool   Returns 'true' if the load is successful, false otherwise.

Remarks

This method loads the contents of a named file into the binary object data area. The name of the file to load is specified either as a parameter to this function or in a previous call to Binary.fname()

The filename for this method is local to the root of the clients virtual server. So for example "/text.rhtm" locates the file called 'text.rhtm' in the root of the virtual server that executes the Presentation Page.
Whitebeam release 1.3.36
(loadtime : 26ms)