JS SetPendingException

From MDC

Sets the current exception being thrown within a context.

[edit] Syntax

void JS_SetPendingException(JSContext *cx, jsval v);

Name	Type	Description
cx	JSContext *	Pointer to a JS context from which to derive runtime information. Requires request. (In a JS_THREADSAFE build, the caller must be in a request on this JSContext.)
v	jsval	Value to throw as an exception.

[edit] Description

JS_SetPendingException sets the current exception being thrown within a context. If an exception is already being thrown, it is replaced with the new one given.

v is the new value to throw as an exception.

A native function or hook using this to throw an exception must also return JS_FALSE to ensure the exception is thrown.

See examples in the JSAPI Phrasebook.

[edit] See Also

LXR ID Search for JS_SetPendingException

JS_IsExceptionPending, JS_GetPendingException, JS_ClearPendingException, JS_ReportPendingException