JSID_VOID

This article needs a technical review. How you can help.

An additional jsid which is used to indicate the absence of a valid jsid.

Syntax

const jsid JSID_VOID;

const JS::HandleId JSID_VOIDHANDLE; // Added in SpiderMonkey 31

Description

JSID_VOID does not occur in JS scripts but may be used to indicate the absence of a valid jsid. A void jsid is not a valid id and only arises as an exceptional API return value, such as in JS_NextProperty. Embeddings must not pass JSID_VOID into JSAPI entry points expecting a jsid and do not need to handle JSID_VOID in hooks receiving a jsid except when explicitly noted in the API contract.

JSID_VOIDHANDLE is the handle to the jsid which value is JSID_VOID.

See Also

Document Tags and Contributors

 Contributors to this page: kscarfone, arai
 Last updated by: kscarfone,