LoadSystemMethodInfo (XmlDoc subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 34: Line 34:


==Examples==
==Examples==
<ol><li>
The following request displays the class data for the AddAttribute method:
The following request displays the class data for the AddAttribute method:
<p class="code">begin
<p class="code">begin
Line 64: Line 63:
   </class>
   </class>
</classes>
</classes>
</p></ol>
</p>


==See also==
==See also==
{{Template:XmlDoc:LoadSystemMethodInfo footer}}
{{Template:XmlDoc:LoadSystemMethodInfo footer}}

Revision as of 14:37, 23 May 2011

Load info about system methods into this XmlDoc (XmlDoc class)

LoadSystemMethodInfo loads an XmlDoc with information about methods in classes selected by a "pattern" argument. This method is primarily intended for User Language products delivered by Sirius Software, and the schema of the document may change from release to release.

Syntax

doc:LoadSystemMethodInfo( pattern, [ShowBase= boolean])

Syntax terms

doc An expression that points to the XmlDoc to contain the selected method information.
pattern A string whose case is ignored and which can have any of the following forms:
methodPattern This selects, from any system class, all methods which match the specified pattern.
classPattern':'methodPattern This selects, from any system class matching classPattern, all methods which match methodPattern.
'System:'classPattern':'methodPattern This is the same as classPattern':'methodPattern.
showBase A "Boolean Enumeration" to control the handling of base and extentions classes:
  • If False, the default, then base classes are omitted from the output XmlDoc, and the methods in extension classes include methods from their base classes.
  • If True, then base classes (which match the selection pattern) are included in the output XmlDoc, and the members of base classes are not included in extension classes.
This argument is new in version 7.9 of the Sirius Mods.

Usage notes

  • The "New" method will only be displayed if either is true:
    • The methodPattern is the string New.
    • The New method has any arguments.
  • LoadSystemMethodInfo will not display classes in the module LOCAL, if they are selected by a pattern (that is, pattern contains a wildcard character), or if there is no classPattern component.

Examples

The following request displays the class data for the AddAttribute method:

begin %d is object xmlDoc %d = new %d:loadSystemMethodInfo('AddAttribute') %d:print end

The example result follows:

<classes selection="AddAttribute"> <class name="XMLNODE" system="yes" new="no" discard="no"> <methods module="JSOPF" offset="00000CBC"> <method name="ADDATTRIBUTE" type="function" callable="yes"> <result> <type name="Object" class="XMLNODE"/> </result> <arg> <type name="Longstring"/> </arg> <arg> <type name="Longstring"/> </arg> <arg optional="yes"> <type name="Longstring"/> </arg> </method> </methods> </class> </classes>

See also