JavaScript-1.5 Reference

JS_FinalizeStub Function

Summary

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

Syntax

void JS_FinalizeStub(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_FinalizeStub provides a convenient way to pass a finalization object to an API function that requires one without requiring you to create an actual finalization object. This is especially useful for internal operations, such as class definitions. A conversion stub is a placeholder for an actual finalization function.

As designed, JS_FinalizeStub 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_EnumerateStub | JS_PropertyStub | JS_ResolveStub ]

This page was generated by APIDOC