mozilla
Your Search Results

    JS_SetGlobalObject

    Obsolete since JSAPI 25
    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.

    Set a context's global object.

    Syntax

    void
    JS_SetGlobalObject(JSContext *cx, JSObject *obj);
    
    Name Type Description
    cx JSContext * The context to configure. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
    obj JSObject * Pointer to the object to set as the global object, or NULL.

    Description

    This function is obsolete; see also JS_GetGlobalObject.

    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 JSAPI User Guide.

    See Also

    Document Tags and Contributors

    Contributors to this page: Sheppy, Jorend, Dmandelin, Dria, MMondor, Amohr, arai
    Last updated by: arai,
    Hide Sidebar