JS CallFunctionValue

From MDC

Calls a specified JS function.

[edit] Syntax

JSBool JS_CallFunctionValue(JSContext *cx, JSObject *obj,
    jsval fval, uintN argc, jsval *argv, jsval *rval);

Name	Type	Description
cx	JSContext *	Pointer to a JS context from which to derive runtime information. Requires request. (In a JS_THREADSAFE build, the caller must be in a request on this JSContext.)
obj	JSObject *	The "current" object on which the function operates; the object specified here is "this" when the function executes.
fval	jsval	The jsval containing the function to execute.
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 *	Out parameter. On success, *rval receives the return value from the function call.

[edit] Description

JS_CallFunctionValue executes a function referenced by a jsval, fval, on an object, obj. In terms 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.

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_CallFunctionValue returns JS_TRUE. Otherwise it returns JS_FALSE, and rval is undefined.

[edit] See Also

LXR ID Search for JS_CallFunctionValue

JS_CallFunction, JS_CallFunctionName, JS_CompileFunction, JS_DefineFunction, JS_DefineFunctions, JS_GetFunctionObject, JS_NewFunction, JS_ValueToFunction