Method Description

XmlGeneric.clean()

Discard generated output from this element

Syntax

XmlGeneric.XmlGeneric = XmlGeneric.clean()

Parameters

The 'XmlGeneric.clean' method takes no parameters

Results

The 'XmlGeneric.clean' method returns structure:

Remarks

When XML node is executed they accumulate output data that is aggregated up through the tree. Most of the times the amount of information stored is small. There are however occassions when the amount of data accumulated, for example in very big reports, can cause a problem - making the web-server processor have an excessively large memory footprint.

This method allows carefully constructed pages to mitigate the use of memory by causing areas of the working memory for branches of that tree to be discarded after use.

Invoking the 'clean' method on an XML element (XmlGeneric) will cause that element to free it's generated output.

The output can be re-created at any time by executing that branch. Immediately after cleaning an XML tree the value returned by "elem.toString()" will be an empty string.

Note : the memory released is only the working memory for the branch. The XML structure is retained and can be accessed and manipulated.