JS_ConvertArgumentsVA

by 3 contributors:

Obsolete since JSAPI 38
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.

Converts a series of JS values, passed in a va_list, to their corresponding JSAPI types.

Syntax

bool
JS_ConvertArgumentsVA(JSContext *cx, const JS::CallArgs &args,
                      const char *format, va_list ap);

bool
JS_ConvertArgumentsVA(JSContext *cx, unsigned argc, jsval *argv,
                      const char *format, va_list ap);
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.
args const JS::CallArgs &

Reference to the arguments to convert. Added in SpiderMonkey 31

argc unsigned The number of arguments to convert. Obsolete since JSAPI 30
argv jsval * Pointer to the vector of arguments to convert. Obsolete since JSAPI 30
format const char * Character array containing the recognized format to which to convert.
ap va_list The list of pointers into which to store the converted types. There should be one pointer for each converted value. The type va_list is a standard feature of the C programming language. It is defined in <stdarg.h>.

Description

JS_ConvertArgumentsVA is to JS_ConvertArguments as vprintf is to printf. See JS_ConvertArguments for further information.

If JS_ConvertArgumentsVA successfully converts all arguments, it returns true. Otherwise it returns false.

See Also

Document Tags and Contributors

Contributors to this page: fscholz, arai, Jorend
Last updated by: fscholz,
Hide Sidebar