JS::CreateError

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

This article covers features introduced in SpiderMonkey 38

Create an Error object.

Syntax

// Added in SpiderMonkey 45

bool
JS::CreateError(JSContext *cx, JSExnType type, HandleObject stack,
                HandleString fileName, uint32_t lineNumber, uint32_t columnNumber,
                JSErrorReport *report, HandleString message, MutableHandleValue rval);

// Obsolete since JSAPI 39

bool
JS::CreateError(JSContext *cx, JSExnType type, HandleString stack,
                HandleString fileName, uint32_t lineNumber, uint32_t columnNumber,
                JSErrorReport *report, HandleString message, MutableHandleValue rval);
Name Type Description
cx JSContext * Pointer to a JS context from which to derive runtime information. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
type JSExnType The exception's type.
stack JS::HandleString or JS::HandleObject The value of Error.prototype.stack.
fileName JS::HandleString The value of Error.prototype.fileName.
lineNumber uint32_t The value of Error.prototype.lineNumber.
columnNumber uint32_t The value of Error.prototype.columnNumber.
report JSErrorReport * A pointer to JSErrorReport instance.
message JS::HandleString The value of Error.prototype.message.
rval JS::MutableHandleValue Out parameter. Receives the created error object.

Description

JS::CreateError creates an Error object with specified properties.

If successful, JS::CreateError stores the created error object to *rval and returns true, otherwise returns false and the value of *rval is undefined.

See Also

Document Tags and Contributors

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