Entry: JS_GetProperty (Function)
Summary: Finds a specified property and retrieves its value.
Syntax:
JSBool JS_GetProperty(JSContext *cx, JSObject *obj,
const char *name, jsval *vp);
Argument Type Description
cx JSContext * Pointer to a JS context from which to derive runtime information.
obj JSObject * Object to search on for the property.
name const char * Name of the property to look up.
vp jsval * Pointer to a variable into which to store the current value of the property if it exists. If not, vp is set to JSVAL_VOID.
Description:
JS_GetProperty examines a specified JS object, obj, its scope and prototype links, for a property named name. If the property is not defined on the object in its scope, or in its prototype links, vp is set to JSVAL_VOID.
If the property exists, JS_GetProperty sets vp to the current value of the property, and returns JS_TRUE. If an error occurs during the search, JS_GetProperty returns JS_FALSE, and vp is undefined.
See also:
[sh-index] Back to list of manuals
|
| |
