JS RemoveRoot

Unregisters 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

JSBool JS_RemoveValueRoot(JSContext *cx, jsval *vp);

JSBool JS_RemoveStringRoot(JSContext *cx, JSString **spp);

JSBool JS_RemoveObjectRoot(JSContext *cx, JSObject **opp);

JSBool JS_RemoveGCThingRoot(JSContext *cx, void **rp);
Name Type Description
cx JSContext * A context. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
vp jsval * Address of the jsval variable to remove from the root set.  This must have been passed to either JS_AddValueRoot or JS_AddNamedValueRoot.
spp JSString ** Address of the JSString* variable to remove from the root set.  This must have been passed to either JS_AddStringRoot or JS_AddNamedStringRoot.
opp 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 void ** Address of the pointer variable to remove from the root set.  This must have been passed to either JS_AddGCThingRoot or JS_AddNamedGCThingRoot.

Description

JS_RemoveRoot removes the variable that rp points to from the garbage collector's root set.

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

JS_RemoveRoot always returns JS_TRUE.

MXR ID Search for JS_RemoveValueRoot
MXR ID Search for JS_RemoveStringRoot
MXR ID Search for JS_RemoveObjectRoot
MXR ID Search for JS_RemoveGCThingRoot

Document Tags and Contributors

Last updated by: Jorend,