Entry: JS_ValueToNumber (Function)
Summary: Converts a JS value to a JS double.
Syntax:
JSBool JS_ValueToNumber(JSContext *cx, jsval v,
jsdouble *dp);
Argument Type Description
cx JSContext * Pointer to a JS context from which to derive runtime information.
v jsval The JS value to convert.
dp jsdouble * Pointer to the JS value that contains the converted double when the function returns.
Description:
JS_ValueToNumber converts a specified JS value, v, to a JS double. The converted value is stored in the jsdouble pointed to by dp.
You can convert a JS value to a number if the JS value to convert is a JSVAL_INT, JSVAL_DOUBLE, or JSVAL_BOOLEAN. If the JS value is a JSVAL_STRING that contains numeric values and signs only, conversion also succeeds. If the JS value is a JSVAL_OBJECT, conversion is successful if the object's convert operation returns a primitive value that can be converted.
When conversion is successful, JS_ValueToNumber returns JS_TRUE. Otherwise, it reports an error and returns JS_FALSE.
See also:
[sh-index] Back to list of manuals
|
| |
