JavaScript-1.5 Reference

JS_RemoveRoot Function

Summary

Removes a garbage collection hash table entry for a specified JS item to enable it to be garbage collected.

Syntax

JSBool JS_RemoveRoot(JSContext *cx, void *rp);
NameTypeDescription
cxJSContext *Pointer to a JS context from which to derive runtime information.
rpvoid *Pointer to the item to remove from the hash table.

Description

JS_RemoveRoot removes an entry for a a specified item, rp, from the garbage collection hash table. When an item is removed from the hash table, it can be garbage collected. rp is a pointer to a JS double, string, or object. An entry for the item is removed in the garbage collection hash table for the specified executable script context, cx.

JS_RemoveRoot always returns JS_TRUE.

See Also

Groups [ Function ]
Documents [ LXR ID Search ]
Entries [ JS_AddNamedRoot | JS_AddRoot | JS_DumpNamedRoots ]

This page was generated by APIDOC