JS_GetPropertyDescriptor

Finds a specified property of an object and gets a detailed description of that property.

Syntax

bool
JS_GetPropertyDescriptor(JSContext *cx, JS::HandleObject obj, const char *name,
                         JS::MutableHandle<JSPropertyDescriptor> desc); // Added in SpiderMonkey 31
bool
JS_GetPropertyDescriptorById(JSContext *cx, JS::HandleObject obj, JS::HandleId id,
                             JS::MutableHandle<JSPropertyDescriptor> desc);
Name Type Description
cx JSContext * A context. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
obj JS::HandleObject The object to search for the property.
id const char * or JS::HandleId The name of the property to look up.
desc JS::MutableHandle<JSPropertyDescriptor> Out parameter. On success, if no property is found, desc->obj is set to NULL. If a property is found, *desc receives a description of it.

Description

JS_GetPropertyDescriptor and JS_GetPropertyDescriptorById find a specified property of an object and gets a detailed description of that property on the prototype chain (returned in desc->obj). If desc->obj is null, then this property was not found on the prototype chain.

See also

Document Tags and Contributors

Tags: 
 Contributors to this page: fscholz, arai
 Last updated by: fscholz,