JavaScript-1.5 Reference

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);
NameTypeDescription
cxJSContext *Pointer to a JS context from which to derive runtime information.
objJSObject *Object to search on for the property.
nameconst char *Name of the property to look up.
vpjsval *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

Groups [ Function ]
Documents [ LXR ID Search ]
Entries [ JSVAL_VOID | JS_AliasProperty | JS_DefineProperty | JS_DefinePropertyWithTinyId | JS_DefineUCProperty | JS_DefineUCPropertyWithTinyID | JS_DeleteProperty | JS_DeleteProperty2 | JS_DeleteUCProperty2 | JS_GetUCProperty | JS_LookupProperty | JS_PropertyStub | JS_SetProperty | JS_SetUCProperty ]

This page was generated by APIDOC