NewFromGlobal (PersistentObjectInfo function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Syntax terms) |
||
| Line 7: | Line 7: | ||
<tr><th>%persObjInfo</th><td>A <var>PersistentObjectInfo</var> object variable.</td></tr> | <tr><th>%persObjInfo</th><td>A <var>PersistentObjectInfo</var> object variable.</td></tr> | ||
<tr><th><var>[(PersistentObjectInfo)]</var></th> | <tr><th><var>[(PersistentObjectInfo)]</var></th> | ||
<td> | <td>For a shared function, this optional specification of the class in parentheses denotes a [[Notation conventions for methods#Shared methods|virtual constructor]]. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>PersistentObjectInfo</var> virtual constructor.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>A string that identifies the name of the global variable whose information is returned to <var class="term">%persObjList</var>.</td></tr> | <td>A string that identifies the name of the global variable whose information is returned to <var class="term">%persObjList</var>.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | |||
<ul> | |||
<li>As described in [[Object variables#Virtual Constructor methods|"Virtual Constructor methods"]], <var>IsNull</var> and <var>IsNotNull</var> can be invoked with | |||
no method object, with an explicit class specification, or with an object variable of the class, | |||
even if that object is <var>Null</var>: | |||
<p class="code">%selCrit = IsNull | |||
%selCrit = %(SelectionCriterion for float):IsNotNull | |||
%selCrit = %selCrit:IsNull | |||
</p> | |||
'''Note:''' | |||
As shown in the second of these above, if you explicitly specify the | |||
class name, you must include the item datatype of the collection to be searched, just as on a <var>SelectionCriterion</var> object variable's [[SelectionCriterion class#Declaring a SelectionCriterion object variable|declaration]]. | |||
</ul> | |||
==Usage notes== | ==Usage notes== | ||
Revision as of 01:15, 23 August 2011
Get info about global object (PersistentObjectInfo class)
[Introduced in Sirius Mods 7.8]
Syntax
%persObjInfo = [%(PersistentObjectInfo):]NewFromGlobal( name)
Syntax terms
| %persObjInfo | A PersistentObjectInfo object variable. |
|---|---|
| [(PersistentObjectInfo)] | For a shared function, this optional specification of the class in parentheses denotes a virtual constructor. See "Usage notes", below, for more information about invoking a PersistentObjectInfo virtual constructor. |
| string | A string that identifies the name of the global variable whose information is returned to %persObjList. |
Usage notes
- As described in "Virtual Constructor methods", IsNull and IsNotNull can be invoked with
no method object, with an explicit class specification, or with an object variable of the class,
even if that object is Null:
%selCrit = IsNull %selCrit = %(SelectionCriterion for float):IsNotNull %selCrit = %selCrit:IsNull
Note: As shown in the second of these above, if you explicitly specify the class name, you must include the item datatype of the collection to be searched, just as on a SelectionCriterion object variable's declaration.