LoadSystemMethodInfo (XmlDoc subroutine): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:XmlDoc:LoadSystemMethodInfo subtitle}} | |||
[[Category:XmlDoc methods|LoadSystemMethodInfo subroutine]] | [[Category:XmlDoc methods|LoadSystemMethodInfo subroutine]] | ||
[[Category:XmlDoc API methods]] | [[Category:XmlDoc API methods]] | ||
| Line 10: | Line 10: | ||
This method loads an XmlDoc with information about methods in | This method loads an XmlDoc with information about methods in | ||
classes selected by a | classes selected by a "pattern" argument. | ||
This method is primarily intended for User Language products delivered | This method is primarily intended for User Language products delivered | ||
by Sirius Software, and the schema of the document may change from release | by Sirius Software, and the schema of the document may change from release | ||
to release. | to release. | ||
==Syntax== | |||
{{Template:XmlDoc:LoadSystemMethodInfo syntax}} | |||
===Syntax terms=== | |||
<dl> | <dl> | ||
| Line 39: | Line 38: | ||
</dl> | </dl> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>The | <li>The "New" method will only be displayed if either is | ||
true: | true: | ||
<ul> | <ul> | ||
Revision as of 16:58, 22 January 2011
Load info about system methods into this XmlDoc (XmlDoc class)
LoadSystemMethodInfo is a member of the XmlDoc class.
This method 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.
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.
Example
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>