JS::Remove*Root

Obsolete since JSAPI 38
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.

This article covers features introduced in SpiderMonkey 31

Unregister a pointer to a GC thing so that it is no longer a member of the garbage collector's root set. This enables any pointed-at GC thing to be garbage collected as needed.

Syntax

void
RemoveValueRoot(JSContext *cx, JS::Heap<JS::Value> *vp);
void
RemoveStringRoot(JSContext *cx, JS::Heap<JSString *> *rp);
void
RemoveObjectRoot(JSContext *cx, JS::Heap<JSObject *> *rp);
void
RemoveScriptRoot(JSContext *cx, JS::Heap<JSScript *> *rp);
void
RemoveValueRootRT(JSRuntime *rt, JS::Heap<JS::Value> *vp);
void
RemoveStringRootRT(JSRuntime *rt, JS::Heap<JSString *> *rp);
void
RemoveObjectRootRT(JSRuntime *rt, JS::Heap<JSObject *> *rp);
void
RemoveScriptRootRT(JSRuntime *rt, JS::Heap<JSScript *> *rp);
Name Type Description
cx JSContext * The context from which to remove the root. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
rt JSRuntime * The runtime from which to remove the root.
vp JS::Heap<JS::Value> Address of the JS::Value variable to remove from the root set. This must have been passed to one of JS::AddValueRoot, JS::AddNamedValueRoot or JS::AddNamedValueRootRT.
rp JS::Heap<JSString *> Address of the JSString * variable to remove from the root set. This must have been passed to either JS::AddStringRoot or JS::AddNamedStringRoot.
rp JS::Heap<JSObject *> Address of the JSObject * variable to remove from the root set. This must have been passed to either JS::AddObjectRoot or JS::AddNamedObjectRoot.
rp JS::Heap<JSScript *> Address of the JSScript * variable to remove from the root set. This must have been passed to JS::AddNamedScriptRoot.

Description

JS::Remove*Root removes the variable that rp points to from the garbage collector's root set.

The entry for vp/rp is removed from the root set for the JSRuntime associated with the context cx.

See Also

Document Tags and Contributors

Tags: 
 Contributors to this page: arai, kscarfone
 Last updated by: arai,