JavaScript-1.5 Reference

JS_CompileScript Function

Summary

Compiles a script for execution.

Syntax

JSScript * JS_CompileScript(JSContext *cx, JSObject *obj,
    const char *bytes, size_t length, const char *filename,
    uintN lineno);
NameTypeDescription
cxJSContext *Pointer to a JS context from which to derive runtime information.
objJSObject *Object with which the script is associated.
bytesconst char *String containing the script to compile.
lengthsize_tSize, in bytes, of the script to compile.
filenameconst char *Name of file or URL containing the script. Used to report filename or URL in error messages.
linenouintNLine number. Used to report the offending line in the file or URL if an error occurs.

Description

JS_CompileScript compiles a script, bytes, for execution. The script is associated with a JS object. bytes is the string containing the text of the script. length indicates the size of the text version of the script in bytes.

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

If a script compiles successfully, JS_CompileScript returns a pointer to the compiled script. Otherwise JS_CompileScript returns NULL, and reports an error.

Notes

To compile a script using a Unicode character set, call JS_CompileUCScript instead of this function.

To compile a script from an external file source rather than passing the actual script as an argument, use JS_CompileFile instead of JS_CompileScript.

See Also

Groups [ Function ]
Documents [ LXR ID Search ]
Entries [ JS_CompileFile | JS_CompileUCScript | JS_DecompileScript | JS_DestroyScript | JS_EvaluateScript | JS_ExecuteScript ]

This page was generated by APIDOC