Skip to main content

Visit Mozilla.org

JS EvaluateScriptForPrincipals

From MDC

Main Page > SpiderMonkey > JSAPI Reference > JS_EvaluateScriptForPrincipals

Compile and execute a security-enabled script.

[edit] Syntax 

JSBool JS_EvaluateScriptForPrincipals(JSContext *cx,
    JSObject *obj, JSPrincipals *principals, const char *src,
    uintN length, const char *filename, uintN lineno,
    jsval *rval);

JSBool JS_EvaluateScriptUCForPrincipals(JSContext *cx,
   JSObject *obj, JSPrincipals *principals, const jschar *src,
   uintN length, const char *filename, uintN lineno,
   jsval *rval);


Name Type Description
cx JSContext * The context in which to run the script.

Requires request. (In a JS_THREADSAFE build, the caller must be in a request on this JSContext.)
obj JSObject * The scope in which to execute the script. This parameter is documented in detail at JS_ExecuteScript.
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 and execute.
length uintN The length of src, in characters.
filename const char * Name of file or URL containing the script. 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.
rval jsval * Out parameter. On success, *rval receives the value from the last-executed expression statement in the script.

[edit] Description

JS_EvaluateScriptForPrincipals compiles and executes a script in the specified scope, obj. JS_EvaluateUCScriptForPrincipals is the Unicode version of the function.

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 is the length of the script, in characters.

filename is the name of the file (or URL) containing the script. This information is used in 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.

If the script compiles and executes successfully, *rval receives the value from the last-executed expression statement processed in the script, and JS_EvaluateScriptForPrincipals or JS_EvaluateUCScriptForPrincipals returns JS_TRUE. Otherwise it returns JS_FALSE, and the value left in *rval is undefined.

[edit] See Also

LXR ID Search for JS_EvaluateScriptForPrincipals
LXR ID Search for JS_EvaluateUCScriptForPrincipals

JS_CompileFile, JS_CompileScriptForPrincipals, JS_EvaluateScript

Retrieved from "http://developer.mozilla.org/en/docs/JS_EvaluateScriptForPrincipals"