AcornSearch - Acorn and RISC OS information searching
RISC OS Search
containing
"Nutty quip goes here!"
Home  |  About  |  Filebase Archive  |  StrongHelp Manuals  |  Newsgroups  |  Module Database
Entry:     JS_GetPrivate (Function)
Summary:     Retrieves the private data associated with an object.
Syntax:
void * JS_GetPrivate(JSContext *cx, JSObject *obj);

     Argument     Type     Description
     cx     JSContext *     Pointer to a JS context from which to derive runtime information.
                 
     obj     JSObject *     Object for which to retrieve private data.
                 
Description:
JS_GetPrivate retrieves the private data associated with a specified object, obj. To retrieve private data, an object must be an instance of a class, and that class must include the JSCLASS_HAS_PRIVATE flag.

If successful, JS_GetPrivate returns a pointer to the private data. Otherwise it returns NULL which can mean either that there is no private data currently associated with the object, or that the object cannot have private data.


See also:
JSCLASS_HAS_PRIVATE
JSClass
JSVAL_TO_PRIVATE
JS_GetInstancePrivate
JS_InitClass
JS_SetPrivate

[sh-index] Back to list of manuals