LoadSystemMethodInfo (XmlDoc subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 17: Line 17:
{{Template:XmlDoc:LoadSystemMethodInfo syntax}}
{{Template:XmlDoc:LoadSystemMethodInfo syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
 
<tr><th>doc</th>
<dt>doc
<td>An expression that points to the XmlDoc to contain the selected method information. </td></tr>
<dd>An expression that points to the XmlDoc to contain the
<tr><th>pattern</th>
selected method information.
<td>A string whose case is ignored and which can have any of the following forms:
<dt>pattern
<table class="syntaxNested">
<dd>A string whose case is ignored and
<tr><th><i>methodPattern</i></th>
which can have any of the following forms:
<td>This selects, from any system class, all methods which match the specified pattern. </td></tr>
<dl>
<tr><th><i>classPattern':'methodPattern</i></th>
<dt><i>methodPattern</i>
<td>This selects, from any system class matching ''classPattern'', all methods which match ''methodPattern''. </td></tr>
<dd>This selects, from any system class, all methods
<tr><th><i>'System:'classPattern':'methodPattern</i></th>
which match the specified pattern.
<td>This is the same as ''classPattern':'methodPattern''. </td></tr>
<dt><i>classPattern':'methodPattern</i>
</table>
<dd>This selects, from any system class matching ''classPattern'',
</td></tr>
all methods which match ''methodPattern''.
</table>
<dt><i>'System:'classPattern':'methodPattern</i>
<dd>This is the same as ''classPattern':'methodPattern''.
</dl>
 
</dl>


==Usage notes==
==Usage notes==

Revision as of 17:50, 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>