JS_ClearNonGlobalObject

by 3 contributors:

Obsolete since JSAPI 34
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 24

Remove all properties associated with an object.

Syntax

void
JS_ClearNonGlobalObject(JSContext *cx, JSObject *obj);
Name Type Description
cx JSContext * The context in which to clear the object. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
obj JSObject * Object from which to delete all properties.

Description

JS_ClearNonGlobalObject removes all of obj's own properties, except the special __proto__ and __parent__ properties, in a single operation. Properties belonging to objects on obj's prototype chain are not affected.

To remove a single property from an object, use JS_DeleteProperty. To remove a single array object element, use JS_DeleteElement.

See Also

Document Tags and Contributors

Contributors to this page: arai, fscholz, tschneidereit
Last updated by: arai,
Hide Sidebar