JavaScript-1.5 Reference

JSVAL_UNLOCK Macro Deprecated

Summary

Unlocks a JS value, enabling garbage collection on it.

Syntax

JSVAL_UNLOCK(cx,v)

Description

JSVAL_UNLOCK is a deprecated feature that is supported only for backward compatibility with existing applications. To unlock a value, use local roots with JS_RemoveRoot.

JSVAL_UNLOCK unlocks a previously locked JS value, v, so it can be garbage collected. v is a JS object, string, or double value.

JSVAL_UNLOCK determine if v is an object, string, or double value, and if it is, it unlocks the value. If unlocking is successful, or v is not affected by garbage collection because it is not an object, string, or double value, JSVAL_UNLOCK evaluates to true. Otherwise JSVAL_UNLOCK evaluates to false.

See Also

Groups [ Deprecated | Macro ]
Documents [ LXR ID Search ]
Entries [ JSVAL_IS_GCTHING | JSVAL_LOCK | JSVAL_TO_GCTHING | JS_AddRoot | JS_LockGCThing ]

This page was generated by APIDOC