JSVAL_LOCK

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.

Locks a JS value to prevent garbage collection on it.

Syntax

JSVAL_LOCK(cx,v)

Description

JSVAL_LOCK is a deprecated feature that is supported only for backward compatibility with existing applications. To lock a value, use local roots with JS_AddRoot.

JSVAL_LOCK locks a JS value, v, to prevent the value from being garbage collected. v is a JS object, string, or double value.

JSVAL_LOCK determines if v is an object, string, or double value, and if it is, it locks the value. If locking is successful, or v already cannot be garbage collected because it is not an object, string, or double value, JSVAL_LOCK evaluates to true. Otherwise, it evaluates to false.

See Also

Document Tags and Contributors

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