JavaScript-1.5 Reference

JS_DeleteElement Function

Summary

Public. Removes a specified element or numeric property from an object.

Syntax

JSBool JS_DeleteElement(JSContext *cx, JSObject *obj,
    jsint index);
NameTypeDescription
cxJSContext *Pointer to a JS context from which to derive runtime information.
objJSObject *Object from which to delete an element.
indexjsintIndex 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_DeleteProperty reports the error before returning JS_FALSE. For JavaScript 1.3, the attempt is silently ignored.

Notes

To remove all elements and properties from an object, call JS_ClearScope.

See Also

Groups [ Function ]
Documents [ LXR ID Search ]
Entries [ JS_AliasElement | JS_ClearScope | JS_DefineElement | JS_DeleteElement2 | JS_DeleteProperty | JS_GetArrayLength | JS_GetElement | JS_IsArrayObject | JS_LookupElement | JS_NewArrayObject | JS_SetArrayLength | JS_SetElement ]

This page was generated by APIDOC