JS DefineProperties

From MDC

Define multiple properties for a single object.

[edit] Syntax

JSBool JS_DefineProperties(JSContext *cx, JSObject *obj, JSPropertySpec *ps);

Name	Type	Description
cx	JSContext *	The context in which to define the properties. Requires request. (In a JS_THREADSAFE build, the caller must be in a request on this JSContext.)
obj	JSObject *	The object on which to define new properties.
ps	JSPropertySpec *	Pointer to an array containing names, ids, flags, and getProperty and setProperty method for the properties to create. The last array element must contain 0-valued members.

[edit] Description

JS_DefineProperties creates properties on a specified object, obj.

ps is a pointer to the first element of an array of JSPropertySpec structures. Each array element defines a single property: its name, tiny id, attributes, getter, and setter. The name field of the last array element must be NULL. JS_DefineProperties creates one property for each element in the array before the element with a null name field. Each property is defined as though by calling JS_DefinePropertyWithTinyId.

The initial stored value of each property created is undefined.

On success, JS_DefineProperties returns JS_TRUE, indicating it has created all properties listed in the array. Otherwise it returns JS_FALSE.

[edit] See Also

LXR ID Search for JS_DefineProperties

JS_DefineConstDoubles, JS_DefineElement, JS_DefineFunction, JS_DefineFunctions, JS_DefineObject, JS_DefineProperty, JS_InitClass