API16

API16:JDocumentError/setError

From Joomla! Documentation

Revision as of 22:44, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Set error object <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </spa...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Set error object

[Edit Descripton]

Template:Description:JDocumentError/setError

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

[Edit See Also] Template:SeeAlso:JDocumentError/setError

Examples

<CodeExamplesForm />