New (SortedRecordset constructor): Difference between revisions
m (→Usage notes) |
mNo edit summary |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 11: | Line 11: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%sortedRecordset</th> | <tr><th>%sortedRecordset</th> | ||
<td>A declared <var>SortedRecordset</var> object including its file/group context. | <td>A declared <var>SortedRecordset</var> object including its file/group context.</td></tr> | ||
</td></tr> | |||
<tr><th><var>%(SortedRecordset)</var></th> | <tr><th nowrap="true"><var>[%(SortedRecordset In </var>filOrGrp name<var>):]</var></th> | ||
<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>SortedRecordset</var> <var>Constructor</var>. | <td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>SortedRecordset</var> <var>Constructor</var>.</td></tr> | ||
</td></tr></table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
| Line 27: | Line 27: | ||
</p> | </p> | ||
'''Note:''' | '''Note:''' | ||
As shown above, when explicitly indicating the | As shown above, when explicitly indicating the class, both the class name and the file or group context must be | ||
class, both the class name and the file or group context must be | |||
specified just as they are on the <var>SortedRecordset</var> variable's declaration. | specified just as they are on the <var>SortedRecordset</var> variable's declaration. | ||
<li>If you are creating an extension class of the <var>SortedRecordset</var> class, | <li>If you are creating an extension class of the <var>SortedRecordset</var> class, | ||
you can use <var>New</var> in the <var>Construct</var> statement in the extension class: | you can use <var>New</var> in the <var>Construct</var> statement in the extension class: | ||
<p class="code"> class sordidSet extends sortedRecordset in sordid inherit | <p class="code">class sordidSet extends sortedRecordset in sordid inherit | ||
... | |||
constructor new | |||
construct %(sortedRecordset in sordid):new | |||
... | |||
end constructor | |||
... | |||
end class | |||
</p> | </p> | ||
| Line 46: | Line 46: | ||
==Example== | ==Example== | ||
The <var>New</var> constructor has no parameters and simply | |||
instantiates an empty instance of its class: | instantiates an empty instance of its class: | ||
<p class="code"> %srs is object <var>SortedRecordset</var> in sordid | <p class="code">%srs is object <var>SortedRecordset</var> in sordid | ||
... | |||
%srs = new | |||
</p> | </p> | ||
==See also== | ==See also== | ||
{{Template:SortedRecordset:New footer}} | {{Template:SortedRecordset:New footer}} | ||
Latest revision as of 15:33, 11 November 2012
Create a new SortedRecordset object (SortedRecordset class)
This Constructor instantiates an empty instance of a SortedRecordset object.
Available as of Sirius Mods version 7.6, the New method is an alternative to using a Sort statement factory constructor, as described in "Declaration and instantiation".
Syntax
%sortedRecordset = [%(SortedRecordset In filOrGrp name):]New
Syntax terms
| %sortedRecordset | A declared SortedRecordset object including its file/group context. |
|---|---|
| [%(SortedRecordset In filOrGrp name):] | The optional class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking a SortedRecordset Constructor. |
Usage notes
- As described in "Using New or other Constructors", New can be invoked with no object, with an explicit class specification, or with an object variable in the class, even if that object is Null:
%srecs = new %srecs = %(SortedRecordset in file sirLocal):new %srecs = %srecs:new
Note: As shown above, when explicitly indicating the class, both the class name and the file or group context must be specified just as they are on the SortedRecordset variable's declaration.
- If you are creating an extension class of the SortedRecordset class,
you can use New in the Construct statement in the extension class:
class sordidSet extends sortedRecordset in sordid inherit ... constructor new construct %(sortedRecordset in sordid):new ... end constructor ... end class
The Sort statement constructors cannot be used for this purpose.
Example
The New constructor has no parameters and simply instantiates an empty instance of its class:
%srs is object SortedRecordset in sordid ... %srs = new