Visit Mozilla.org

JS ConvertArgumentsVA

From MDC

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

[edit] Syntax

JSBool JS_ConvertArgumentsVA(JSContext *cx, uintN 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.)

argc uintN The number of arguments to convert.
argv jsval * Pointer to the vector of arguments to convert.
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>.

[edit] 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 JS_TRUE. Otherwise it returns JS_FALSE.

LXR ID Search for JS_ConvertArgumentsVA