JSVAL_UNLOCK

Obsolete since JSAPI 18
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

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 determines if v is an object, string, or double value, and if it is, it unlocks the value. If unlocking is successful, or v not affected by garbage collection because it is not an object, string, or double value, JSVAL_UNLOCK evaluates to true. Otherwise, it evaluates to false.

See Also

Document Tags and Contributors

Contributors to this page: arai, fscholz, ethertank, tschneidereit, Jorend, Rappo
Last updated by: arai,
Hide Sidebar