JS_GetPendingException

Get the current pending exception for a given JSContext.

Syntax

JSBool JS_GetPendingException(JSContext *cx, jsval *vp);
Name Type Description
cx JSContext * Pointer to the JS context in which the exception was thrown. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
vp jsval * Out parameter. On success, *vp receives the current pending exception.

Description

If an exception has been thrown in the context cx, and it has not yet been caught or cleared, JS_GetPendingException stores the exception object in *vp and returns JS_TRUE.

Otherwise, it returns JS_FALSE, and the value left in *vp is undefined.

See examples in the JSAPI Phrasebook.

See Also

MXR ID Search for JS_GetPendingException

JS_IsExceptionPending, JS_ClearPendingException, JS_ReportPendingException, JS_SetPendingException

Document Tags and Contributors

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