JavaScript-1.5 Reference

JS_CompileFile

Function

Compiles a script stored in an external file.

JSScript * JS_CompileFile(JSContext *cx, JSObject *obj,
    const char *filename);

Name	Type	Description
`cx`	`JSContext *`	Pointer to a JS context from which to derive runtime information.
`obj`	`JSObject *`	Object with which the script is associated.
`filename`	`const char *`	Name of file or URL containing the script to compile.

JS_CompileFile compiles the text of script in an external file location for execution by the JS engine.

JS_CompileFile is available only if you compile the JS engine with the JSFILE macro defined.

filename is the name of the file (or URL) containing the script to compile.

If a script compiles successfully, JS_CompileFile returns a pointer to the compiled script. Otherwise JS_CompileFile returns NULL.

To pass a script as an argument to a function rather than having to specify a file location, use JS_CompileScript instead of JS_CompileFile.