Function

JSObjectGetPropertyAtIndex

Gets a property from an object by numeric index.

Declaration

JSValueRef JSObjectGetPropertyAtIndex(JSContextRef ctx, JSObjectRef object, unsigned int propertyIndex, JSValueRef *exception);

Parameters

ctx

The execution context to use.

object

The JSObject whose property you want to get.

propertyIndex

An integer value that is the property's name.

exception

A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception.

Return Value

The property's value if object has the property, otherwise the undefined value.

Discussion

Calling JSObjectGetPropertyAtIndex is equivalent to calling JSObjectGetProperty with a string containing propertyIndex, but JSObjectGetPropertyAtIndex provides optimized access to numeric properties.