LoadSystemMethodInfo (XmlDoc subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 44: Line 44:
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
%d is <var>Object</var> <var>XmlDoc</var>
%d is Object XmlDoc
%d = New
%d = New
%d:<var>LoadSystemMethodInfo</var>('AddAttribute')
%d:LoadSystemMethodInfo('AddAttribute')
%d:Print
%d:Print
End
End
Line 53: Line 53:
The example result follows.
The example result follows.
<p class="output"><classes selection="AddAttribute">
<p class="output"><classes selection="AddAttribute">
<class name="XMLNODE" system="yes" new="no" discard="no">
  <class name="XMLNODE" system="yes" new="no" discard="no">
  <methods module="JSOPF" offset="00000CBC">
    <methods module="JSOPF" offset="00000CBC">
    <method name="ADDATTRIBUTE" type="function" callable="yes">
      <method name="ADDATTRIBUTE" type="function" callable="yes">
      <result>
        <result>
        <type name="<var>Object</var>" class="XMLNODE"/>
          <type name="<var>Object</var>" class="XMLNODE"/>
      </result>
        </result>
      <arg>
        <arg>
        <type name="<var>Longstring</var>"/>
          <type name="<var>Longstring</var>"/>
      </arg>
        </arg>
      <arg>
        <arg>
        <type name="<var>Longstring</var>"/>
          <type name="<var>Longstring</var>"/>
      </arg>
        </arg>
      <arg optional="yes">
        <arg optional="yes">
        <type name="<var>Longstring</var>"/>
          <type name="<var>Longstring</var>"/>
      </arg>
        </arg>
    </method>
      </method>
  </methods>
    </methods>
</class>
  </class>
</classes>
</classes>
</p>
</p>
==See also==
==See also==
{{Template:XmlDoc:LoadSystemMethodInfo footer}}
{{Template:XmlDoc:LoadSystemMethodInfo footer}}

Revision as of 16:24, 7 February 2011

Load info about system methods into this XmlDoc (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>

See also