nsIScriptError2

by 3 contributors:

Represents JavaScript errors and warnings for use by the console service; augments nsIScriptError by adding a way to initialize the error with the window ID of the outer window with which the error is associated.
1.0
28
Introduced
Gecko 2.0
Obsolete
Gecko 12.0
Inherits from: nsIScriptError Last changed in Gecko 9.0 (Firefox 9.0 / Thunderbird 9.0 / SeaMonkey 2.6)

Gecko 12.0 note
(Firefox 12.0 / Thunderbird 12.0 / SeaMonkey 2.9)

In Gecko 12.0 this Interface was merged into the nsIScriptError interface.

Method overview

void initWithWindowID(in wstring message, in wstring sourceName, in wstring sourceLine, in PRUint32 lineNumber, in PRUint32 columnNumber, in PRUint32 flags, in string category, in unsigned long long innerWindowID);

Attributes

Attribute Type Description
innerWindowID unsigned long long The inner window ID with which the error is associated. This is zero if the error was initialized by calling nsIScriptError.init() instead of initWithWindowID(). Read only.
outerWindowID unsigned long long The window ID with which the error is associated. This is zero if the error was initialized by calling nsIScriptError.init() instead of initWithWindowID(). Read only.
timeStamp long long Elapsed time, in milliseconds, from a platform-specific zero time to the time the message was created. Read only.

Methods

initWithWindowID()

void init(
  in wstring message,
  in wstring sourceName,
  in wstring sourceLine,
  in PRUint32 lineNumber,
  in PRUint32 columnNumber,
  in PRUint32 flags,
  in string category,
  in unsigned long long innerWindowID
);
Parameters
message
The text of the message to add to the log.
sourceName
The URL of the file in which the error occurred. This will be a hyperlink in the JavaScript Console, so you should use a real URL. You may pass null if it's not applicable.
sourceLine
The line number in the source file on which the error occurred. You are responsible for providing that line. You may pass null if you are lazy; that will prevent showing the source line in JavaScript Console.
lineNumber
The number of the line where the error occurred.
columnNumber
The column number where the error occurred. This is used to draw an arrow pointing to the problem character.
flags
One of the script error flag constants.
category
A string indicating what kind of code caused the message. There are quite a few category strings and they don't seem to be listed in a single place. See Categories for a partial list.
innerWindowID
The ID of the inner window associated with the error. Prior to Gecko 9.0 (Firefox 9.0 / Thunderbird 9.0 / SeaMonkey 2.6), this was the outer window ID.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, fscholz, trevorh
Last updated by: Sheppy,