Obsolete since JSAPI 28
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.
jsval to a
JSString * JS_ValueToString(JSContext *cx, jsval v);
||The context in which to perform the conversion. Requires request. In a
||The value to convert.|
vis already a string, conversion succeeds.
undefined, conversion succeeds, and the result is the string
vis a number, conversion succeeds, and the result is a string representation of that number as specified in ECMA 262-3 §9.8.1. This might be
"-Infinity". Otherwise the result is a decimal representation of the number, possibly using exponential notation.
- Otherwise v is an object. JS_ValueToString uses the steps below to convert it to a string. If at any point an error or exception occurs, or conversion succeeds, the rest of the steps are skipped. (This behavior is implemented by
JSObjectOps.defaultValuemethod, so host objects can override it all.)
v.toString()is a function, it is called. If that method returns a primitive value, the value is converted to a string as described above and conversion succeeds.
- Otherwise, the resulting object's
JSClass.convertcallback is called. For standard classes, this is
JS_ConvertStub, which simply calls
v.valueOf()if present. If the
convertcallback produces a primitive value, the value is converted to a string as described above and conversion succeeds.
- Otherwise conversion fails with a
JS_ValueToString returns a pointer to a string. On error or exception, it returns
NULL. This happens, for example, if
v is an object and
v.toString() throws an exception.
JSString is subject to garbage collection. Protect it using a local root, an object property, or the