JS_ClearPendingException

Clear the currently pending exception in a context.

Syntax

void JS_ClearPendingException(JSContext *cx);
Name Type Description
cx JSContext * The context in which the exception was thrown. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.

Description

JS_ClearPendingException cancels the currently pending exception in cx, if any. (There is a pending exception if the most recently thrown exception in cx has not yet been caught or cleared.)

When any JSAPI call fails with an exception, the caller must either use JS_ClearPendingException to catch the exception; or return JS_FALSE to allow the exception to propagate to the caller.

Note that a JSAPI failure does not necessarily indicate that an exception is pending. Many JSAPI functions can simply report an error and return JS_FALSE without building and throwing an exception object. Use JS_IsExceptionPending or JS_GetPendingException to check for a pending exception.

See examples in the JSAPI Phrasebook.

See Also

MXR ID Search for JS_ClearPendingException

JS_GetPendingException, JS_IsExceptionPending, JS_ReportPendingException, JS_SetPendingException

Document Tags and Contributors

Contributors to this page: Jorend
Last updated by: Jorend,