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_DumpNamedRoots (Function)
Summary:     Enumerates the named roots in the garbage collection hash table.
Syntax:
void JS_DumpNamedRoots(JSRuntime *rt,
void (*dump)(const char *name, void *rp, void *data),
void *data);

     Argument     Type     Description
     rt     JSRuntime *     Pointer to a JSRuntime from which to dump named roots
                 
     dump     void *     Pointer to function that actually dumps the named roots
                 
     data     void *     Pointer to a storage area into which to put a root's data.
                 
Description:
JS_DumpNamedRoots retrieves information from the garbage collection hash table about the named roots associated with a specific JSRuntimert.

dump is the name of the function that actually retrieves the information from the hash table. If you pass a null pointer for this argument, the JS engine defaults to using an internal retrieval function. If you write your own dump function to replace the internal engine function, note that the function you write must accept the following arguments, in order: TABLE BORDER="0" TRTD VALIGN='baseline' ALIGN='left' BArgument /B/TDTD VALIGN='baseline' ALIGN='left' BType /B/TDTD VALIGN='baseline' ALIGN='left' BDescription /B /TD/TRTR TD VALIGN='baseline' ALIGN='left'P CODEname/CODE/TDTD VALIGN='baseline' ALIGN='left'P CODEconst char */CODE/TDTD VALIGN='baseline' ALIGN='left'P Name of the current hash entry./P /TD/TRTR TD VALIGN='baseline' ALIGN='left'P CODErp/CODE/TDTD VALIGN='baseline' ALIGN='left'P CODEvoid */CODE/TDTD VALIGN='baseline' ALIGN='left'P Pointer to the named roots/P /TD/TRTR TD VALIGN='baseline' ALIGN='left'P data/TDTD VALIGN='baseline' ALIGN='left'P void */TDTD VALIGN='baseline' ALIGN='left'P Pointer to a storage area into which to put a root's data./P /TD/TR/TABLE  

data is a pointer to the storage structure into which to return retrieved information. If you pass a null pointer for this argument the JS engine defaults to using an internal storage structure for this information. If you write your own dump function, data must be the same as the last argument passed to the dump function.


See also:
JS_AddNamedRoot
JS_AddRoot
JS_RemoveRoot

[sh-index] Back to list of manuals