JS_LeaveLocalRootScope

Obsolete since JavaScript 1.8.5
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Leave a local root scope.

Syntax

void JS_LeaveLocalRootScope(JSContext *cx);
Name Type Description
cx JSContext * Pointer to the context. This must be the same context passed to JS_EnterLocalRootScope(). Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.

Description

See JS_EnterLocalRootScope for an explanation of local root scopes.

Leaving a nested local root scope causes all objects created since the matching JS_EnterLocalRootScope call to become subject to garbage collection. That is, they are not transferred to the enclosing local root scope. However, JS_LeaveLocalRootScopeWithResult provides a way to transfer one value to the enclosing local root scope.

MXR ID Search for JS_LeaveLocalRootScope

Document Tags and Contributors

Contributors to this page: MarkGiffin, tschneidereit, Waldo, Jorend
Last updated by: tschneidereit,