Entry: JS_CompileFunctionForPrincipals (Function)
Summary: Creates a security-enabled JS function from a text string.
Syntax:
JSFunction * JS_CompileFunctionForPrincipals(JSContext *cx,
JSObject *obj, JSPrincipals *principals, const char *name,
uintN nargs, const char **argnames, const char *bytes,
size_t length, const char *filename, uintN lineno);
Argument Type Description
cx JSContext * Pointer to a JS context from which to derive runtime information.
obj JSObject * Object with which the function is associated.
principals JSPrincipals * Pointer to the structure holding the security information for this function.
name const char * Name to assign the newly compiled function.
nargs uintN Number of arguments to pass to the function.
argnames const char ** Names to assign to the arguments passed to the function.
bytes const char * String containing the function to compile.
length size_t Size, in bytes, of the function to compile.
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.
Description:
JS_CompileFunctionForPrincipals compiles a security-enabled function from a text string, bytes, and associated it with a JS object, obj.
principals is a pointer to the JSPrincipals structure that contains the security information to associate with this function.
name is the name to assign to the newly created function. nargs is the number of arguments the function takes, and argnames is a pointer to an array of names to assign each argument. The number of argument names should match the number of arguments specified in nargs.
bytes is the string containing the text of the function. length indicates the size of the text version of the function in bytes.
filename is the name of the file (or URL) containing the function. This information in messages if an eror occurs during compilation. Similarly, lineno is used to report the line number of the function or file where an error occurred during compilation.
If a function compiles successfully, JS_CompileFunctionForPrincipals returns a pointer to the function. Otherwise JS_CompileFunctionForPrincipals returns NULL.
See also:
[sh-index] Back to list of manuals
|
| |
