JavaScript-1.5 Reference

JS_ConvertStub

Function

Summary

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

Syntax

JSBool JS_ConvertStub(JSContext *cx, JSObject *obj, JSType type,
    jsval *vp);

Name	Type	Description
`cx`	`JSContext *`	Pointer to a JS context from which to derive runtime information.
`obj`	`JSObject *`	Pointer to the object for this stub.
`type`	`JSType`	The type to which to convert this object.
`vp`	`jsval *`	Pointer to the JS value in which to store the conversion.

Description

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

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

See Also

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

This page was generated by APIDOC