ClassDescription (PersistentObjectInfo function): Difference between revisions
m (Automatically generated page update) |
m (→Syntax terms) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%description</th><td>string</td></tr> | <tr><th>%description</th><td> A string variable to contain the class description. Example return strings are "System:Stringlist", "MyUserLanguageClass", and "Arraylist of Object MyUserLanguageClass". </td></tr> | ||
<tr><th> | <tr><th>persObjInfo</th> | ||
<td>PersistentObjectInfo object</td></tr> | <td>A <var>PersistentObjectInfo</var> object variable.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li> | |||
<var>ClassDescription</var> is intended for debugging and problem diagnosis and not for application purposes. The format of its data is subject to change by Sirius; for example, a change in casing. | |||
</ul> | |||
==Examples== | ==Examples== | ||
An example follows: | |||
<p class="code">b | |||
%i is float | |||
%persInfo is object persistentObjectInfo | |||
%sl is object stringlist | |||
%sl = list('alpha', 'beta', 'ceta') | |||
%(Object):SetGlobal('ABC', %sl) | |||
%persInfo = newFromGlobal('ABC') | |||
printText {~} = {%persInfo:name}, {~} = {%persInfo:classDescription} | |||
end | |||
</p> | |||
The result is: | |||
<p class="output">%persInfo:name = ABC, %persInfo:classDescription = System:Stringlist | |||
</p> | |||
==See also== | ==See also== | ||
{{Template:PersistentObjectInfo:ClassDescription footer}} | {{Template:PersistentObjectInfo:ClassDescription footer}} | ||
Latest revision as of 19:03, 19 August 2011
Description of persistent object class (PersistentObjectInfo class)
[Introduced in Sirius Mods 7.8]
Syntax
%description = persObjInfo:ClassDescription
Syntax terms
| %description | A string variable to contain the class description. Example return strings are "System:Stringlist", "MyUserLanguageClass", and "Arraylist of Object MyUserLanguageClass". |
|---|---|
| persObjInfo | A PersistentObjectInfo object variable. |
Usage notes
- ClassDescription is intended for debugging and problem diagnosis and not for application purposes. The format of its data is subject to change by Sirius; for example, a change in casing.
Examples
An example follows:
b %i is float %persInfo is object persistentObjectInfo %sl is object stringlist %sl = list('alpha', 'beta', 'ceta') %(Object):SetGlobal('ABC', %sl) %persInfo = newFromGlobal('ABC') printText {~} = {%persInfo:name}, {~} = {%persInfo:classDescription} end
The result is:
%persInfo:name = ABC, %persInfo:classDescription = System:Stringlist