API15:JDocumentError/setError

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Set error object

Syntax

setError($error)

Parameter Name	Default Value	Description
$error		$error Error object to set

Returns

boolean True on success

Defined in

libraries/joomla/document/error/error.php

Importing

jimport( 'joomla.document.error.error' );

Source Body

function setError($error)
{
        if (JError::isError($error)) {
                $this->_error = & $error;
                return true;
        } else {
                return false;
        }
}

Examples

<CodeExamplesForm />