Visit Mozilla.org

JS SetGlobalObject

From MDC

Set a context's global object.

[edit] Syntax

void JS_SetGlobalObject(JSContext *cx, JSObject *obj);
Name Type Description
cx JSContext * The context to configure.
obj JSObject * Pointer to the object to set as the global object, or NULL.

[edit] Description

JS_SetGlobalObject sets the global object of the context cx to obj. If obj is NULL, the context is set to have no global object.

Each context's global object is in the garbage collector's root set. This means that global objects are automatically protected from garbage collection, as are any values reachable from their properties.

For full ECMAScript standard compliance, obj should be of a JSClass that has the JSCLASS_GLOBAL_FLAGS flag.

Applications typically set a context's global object using JS_InitStandardClasses instead. See the sample code at Embedding SpiderMonkey: JSAPI basics.

LXR ID Search for JS_SetGlobalObject