JS DeleteElement

Removes a specified element or numeric property from an object.

Syntax

JSBool JS_DeleteElement(JSContext *cx, JSObject *obj, jsint index);
Name Type Description
cx JSContext * Pointer to a JS context from which to derive runtime information. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
obj JSObject * Object from which to delete an element.
index jsint Index number of the element to delete.

Description

JS_DeleteElement removes a specified element or numeric property, index, from an object, obj. If an object references an element belonging to a prototype, the element reference is removed from the object, but the prototype's element is not deleted. If deletion is successful, JS_DeleteElement returns JS_TRUE. Otherwise it returns JS_FALSE.

For JavaScript 1.2 and earlier, if failure occurs because you attempt to delete a permanent or read-only element, JS_DeleteElement reports the error before returning JS_FALSE. For JavaScript 1.3 and later, the attempt is silently ignored.

To truncate an array, use JS_SetArrayLength. To remove all elements and properties from an object, call JS_ClearScope.

MXR ID Search for JS_DeleteElement

Document Tags and Contributors

 Last updated by: Jorend,