Whitebeam Template Reference Documentation

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 Template Reference Documentation

System Template

remove()

Removes an existing file or file fragment

See Also

rb.file.get()    rb.file.append()   

Syntax

number = rb.file.remove(fileID, fragmentID)

Parameters

The 'remove' method takes 2 parameters:

Name Type/Value Range/Length Description
fileIDnumberValid fileID Required. Identifier of file to be removed from the catalogue.
fragmentIDnumber-1 or [0,+ve] fragment ID Optional, default = -1
Identifier a specific fragment to be deleted. '-1' means all fragments for this fileID (the default)

Available from version : 1.3.12


Results

The 'remove' method returns number:

Type/Value Range/Length Description
number fileID The original identifier of the removed file.

Remarks

A file can only be removed after all associations to it have been removed.

Whitebeam release 1.3.36
(loadtime : 58ms)