System Template

error()

Generate an error message.

Syntax

void = rb.debug.error(errorString)

Parameters

The 'error' method takes 1 parameter:

Results

The 'error' method returns no useful information.

Remarks

This is a utility that allows a presentation page to generate an error in the same format - and with the same behaviour as the standard Presentation Engine errors.

This facility is particularly well suited to the generation of reusable 'libraries' of code where the utilities in the library are utilised by other Pattern Pages. Such a library may encounter errors with the way it is being used in a presentation page. In these scenarios it is useful for the library to reflect the detected error to the author. This method does exactly this - if it is called it causes the presentation engine to exhibit the same behaviour as an internal Presentation Engine error. Specifically:

1. If the engine is running the live instance - the error is ignored.
2. In a test instance the error message is recorded and page execution aborts.
3. The output from the Pattern Page is replaced by the standard Whitebeam error page.