mozilla
Your Search Results

    JS_CompileScriptForPrincipals

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

    Compile a security-enabled script for execution.

    Syntax

    JSScript *
    JS_CompileScriptForPrincipals(JSContext *cx,
        JSObject *obj, JSPrincipals *principals, const char *src,
        size_t length, const char *filename, uintN lineno);
    
    JSScript *
    JS_CompileUCScriptForPrincipals(JSContext *cx,
        JSObject *obj, JSPrincipals *principals, const jschar *src,
        size_t length, const char *filename, uintN lineno);
    
    JSObject *
    JS_CompileScriptForPrincipalsVersion(JSContext *cx,
        JSObject *obj, JSPrincipals *principals, const char *src, size_t length,
        const char *filename, uintN lineno, JSVersion version); // Obsoleted since JSAPI 19
    
    JSObject *
    JS_CompileUCScriptForPrincipalsVersion(JSContext *cx,
        JSObject *obj, JSPrincipals *principals, const jschar *src,
        size_t length, const char *filename, uintN lineno, JSVersion version); // Obsoleted since JSAPI 19
    
    Name Type Description
    cx JSContext * The context in which to compile the script. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
    obj JSObject * Object with which the script is associated.
    principals JSPrincipals * Pointer to the structure holding the security information for this script.
    src const char * or const jschar * String containing the script to compile.
    length size_t The length of src, in characters.
    filename const char * Name of file or URL containing the function. Used to report filename or URL in error messages.
    lineno uintN Line number. Used to report the offending line in the file or URL if an error occurs.
    version JSVersion JavaScript Version for the script.

    Description

    JS_CompileScriptForPrincipals compiles a security-enabled script, src, for execution. JS_CompileUCScriptForPrincipals is the Unicode version of the function. The script is associated with a JS object.

    principals is a pointer to the JSPrincipals structure that contains the security information to associate with this script.

    src is the string containing the text of the script. length indicates the length of the script, in characters.

    filename is the name of the file (or URL) containing the script. This information is included in error messages if an error occurs during compilation. Similarly, lineno is used to report the line number of the script or file where an error occurred during compilation.

    On success, JS_CompileScriptForPrincipals and JS_CompileUCScriptForPrincipals return a pointer to the compiled script. On error or exception, they return NULL.

    The application is responsible for ensuring that the new compiled script is cleaned up later—either by calling JS_DestroyScript() directly or by calling JS_NewScriptObject(), in which case the garbage collector cleans up the script.

    Warning: This API is subject to bug 438633, which can cause crashes in almost any program that uses JS_DestroyScript(). The workaround is to use JS_NewScriptObject() to root each newly-compiled script, as described in the JSAPI User Guide under Compiled scripts.

    See Also

    Document Tags and Contributors

    Contributors to this page: fscholz, Jorend, Dria, MMondor, arai
    Last updated by: arai,
    Hide Sidebar