JS_NewCompartmentAndGlobalObject

Obsolete since JSAPI 16
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

JS_NewCompartmentAndGlobalObject has been removed in bugĀ 755186. Use JS_NewGlobalObject instead.

Create a new global object in a new compartment.

Syntax

JSObject *JS_NewCompartmentAndGlobalObject(JSContext *cx, JSClass *clasp, 
  JSPrincipals *principals);
Name Type Description
cx JSContext * The context in which to create the new global object. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
clasp JSClass *

The class to use for the new global object.

clasp->flags must have the JSCLASS_GLOBAL_FLAGS bits set.

The caller must ensure that the JSClass remains alive throughout the lifetime of the new object, including the garbage collection cycle that finally frees it. The usual way to do this is to make JSClasses global or static.

principals JSPrincipals * The security information to associate with this compartment.

Description

JS_NewCompartmentAndGlobalObject creates a new compartment, and then creates a new global object as the first object in that compartment.

On success, JS_NewCompartmentAndGlobalObject returns a pointer to the new global object. Otherwise it returns NULL.

Document Tags and Contributors

Contributors to this page: tschneidereit, Dmandelin, sfink, MarkGiffin
Last updated by: sfink,