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

removeList() - Available since version 1.3.9

Removes one or more files referenced by ID

See Also

rb.file.remove()    rb.file.get()    rb.file.create()    rb.file.modify()   

Syntax

number = rb.file.removeList(fileID)

Parameters

The 'removeList' method takes 1 parameter:

Name Type/Value Range/Length Description
fileIDarray of numbersValid fileID Required. An array of fileIDs to be removed from the system.

Results

The 'removeList' method returns number:

Type/Value Range/Length Description
number count Number of files removed

Remarks

Delete a number of file referenced by fileID. This method is equivalent to calling rb.file.remove() for each entry in the array except that all files are removed as part of a single transaction.

Note: this method deletes all fragments for the specified IDs where files comprise more than one fragment.

The method returns the number of file fragments actually deleted.

It is not an error to include IDs that reference non-existent files - such IDs are simply ignored.

removeList was introduced with version 1.3.9
Whitebeam release 1.3.36
(loadtime : 59ms)