JavaScript-1.5 Reference

JS_ValueToInt32

Function

Summary

Converts a JS value to a JS 32-bit integer.

Syntax

JSBool JS_ValueToInt32(JSContext *cx, jsval v, int32 *ip);

Name	Type	Description
`cx`	`JSContext *`	Pointer to a JS context from which to derive runtime information.
`v`	`jsval`	The JS value to convert.
`ip`	`int32 *`	Pointer to the JS value that contains the converted integer when the function returns.

Description

JS_ValueToInt32 converts a specified JS value, v, to a 32-bit integer (-2147483648 to 2147483647). If v is NaN, or a double and out of the 32-bit range, JS_ValueToInt32 reports an error and conversion fails. A double is rounded to the nearest integer value.

The actual conversion is performed by the object's convert operation. The converted value is stored in the int32 pointed to by ip.

You can convert a JS value to an integer 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.

If the conversion is successful, JS_ValueToInt32 returns JS_TRUE. Otherwise, it reports an error and returns JS_FALSE.

JavaScript-1.5 Reference

Summary

Syntax

Description

See Also