AcornSearch - Acorn and RISC OS information searching
RISC OS Search
containing
"Nutty quip goes here!"
Home  |  About  |  Filebase Archive  |  StrongHelp Manuals  |  Newsgroups  |  Module Database
Entry:     JS_CallFunction (Function)
Summary:     Calls a specified function.
Syntax:
JSBool JS_CallFunction(JSContext *cx, JSObject *obj,
JSFunction *fun, uintN argc, jsval *argv, jsval *rval);

     Argument     Type     Description
     cx     JSContext *     Pointer to a JS context from which to derive runtime information.
                 
     obj     JSObject *     The "current" object on which the function operates; the object specified here is "this" when the function executes.
                 
     *fun     JSFunction *     Pointer to the function to call.
                 
     argc     uintN     Number of arguments you are passing to the function.
                 
     argv     jsval *     Pointer to the array of argument values to pass to the function.
                 
     rval     jsval *     Pointer to a variable to hold the return value from the function call.
                 
Description:
JS_CallFunction calls a specified function, fun, on an object, obj. In terns of function execution, the object is treated as this.

In argc, indicate the number of arguments passed to the function. In argv, pass a pointer to the actual argument values to use. There should be one value for each argument you pass to the function; the number of arguments you pass may be different from the number of arguments defined for the function.by the function.

rval is a pointer to a variable that will hold the function's return value, if any, on successful function execution.

If the called function executes successfully, JS_CallFunction returns JS_TRUE. Otherwise it returns JS_FALSE, and rval is undefined.


See also:
JS_CallFunctionName
JS_CallFunctionValue
JS_CompileFunction
JS_DecompileFunction
JS_DecompileFunctionBody
JS_DefineFunction
JS_DefineFunctions
JS_GetFunctionObject
JS_NewFunction
JS_SetBranchCallback
JS_ValueToFunction

[sh-index] Back to list of manuals