New (BadJournal constructor): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (match syntax table to syntax template, tags and edits)
Line 1: Line 1:
{{Template:BadJournal:New subtitle}}
{{Template:BadJournal:New subtitle}}
The <var>New</var> constructor generates an instance of a <var>[[BadJournal_class|BadJournal]]</var> exception object, optionally also setting the <var>ReasonCode</var> property.
This constructor generates an instance of a <var>BadJournal</var> exception.
 
As shown below, the optional argument of the <var>New</var> method is a setting of
the <var>ReasonCode</var> property.
==Syntax==
==Syntax==
{{Template:BadJournal:New syntax}}
{{Template:BadJournal:New syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%bdJrnl</th>
<tr><th>%badJournal</th>
<td>A reference to an instance of a <var>BadJournal</var> object.
<td>A reference to an instance of a <var>[[BadJournal_class|BadJournal]]</var> object.
</td></tr>
</td></tr>
<tr><th>ReasonCode</th>
<tr><th>number</th>
<td>This [[Methods#Named parameters|name required]] parameter specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.
<td>This optional, but <var>[[Methods#Named parameters|Name-Required]]</var> parameter, specifies the numeric reason code to be assigned to the <var>BadJournal</var> exception object's <var>ReasonCode</var> property when a daemon thread is lost.
The possible values are described in [[ReasonCode (BadJournal property)#Syntax terms|"ReasonCode Syntax terms"]].
<p>The possible values are described in "[[ReasonCode (BadJournal property)#Syntax terms|BadJournal ReasonCodes]]".</p>
</td></tr></table>
</td></tr></table>
==Usage Notes==
<ul>
<li><var>New</var> is available in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.8 and later.
</ul>
==See also==
==See also==
{{Template:BadJournal:New footer}}
{{Template:BadJournal:New footer}}

Revision as of 06:02, 10 April 2011

Create a new BadJournal object (BadJournal class)

[Introduced in Sirius Mods 7.8]

The New constructor generates an instance of a BadJournal exception object, optionally also setting the ReasonCode property.

Syntax

%badJournal = [%(BadJournal):]New( ReasonCode= number)

Syntax terms

%badJournal A reference to an instance of a BadJournal object.
number This optional, but Name-Required parameter, specifies the numeric reason code to be assigned to the BadJournal exception object's ReasonCode property when a daemon thread is lost.

The possible values are described in "BadJournal ReasonCodes".

Usage Notes

See also