JSBool JS_ValueToInteger()

Description

This function extracts a function argument from a jsval structure, converts it to an integer (if possible), and passes the converted value back to the caller.

Arguments

JSContext *cx, jsval v, long *lp

  • The cx argument is the opaque JSContext pointer that passes to the JavaScript function.
  • The v argument is the jsval structure from which the integer is to be extracted.
  • The lp argument is a pointer to a 4-byte integer. This function stores the converted value in *lp.

Returns

A Boolean value: JS_TRUE indicates success; JS_FALSE indicates failure.