API16

API16:JDocumentError/setError

From Joomla! Documentation

Revision as of 03:06, 13 May 2013 by JoomlaWikiBot (talk | contribs) (removing red link to edit, no existant pages)

Description

Set error object

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

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;
        }
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />