JavaScript-1.5 Reference

JS_EnumerateStub Function

Summary

Provides a dummy enumeration object for API routines that requires it.

Syntax

JSBool JS_EnumerateStub(JSContext *cx, JSObject *obj);
NameTypeDescription
cxJSContext *Pointer to a JS context from which to derive runtime information.
objJSObject *Pointer to the object for this stub.

Description

JS_EnumerateStub provides a convenient way to pass an enumeration object to an API function that requires one without requiring you to create an actual enumeration object. This is especially useful for internal operations, such as class definitions. An enumeration stub is a placeholder for an actual enumeration function.

As designed, JS_EnumerationStub does not use the arguments you pass to it, and simply returns JS_TRUE.

See Also

Groups [ Function ]
Documents [ LXR ID Search ]
Entries [ JS_ConvertStub | JS_FinalizeStub | JS_PropertyStub | JS_ResolveStub ]

This page was generated by APIDOC