LoadSystemMethodInfo (XmlDoc subroutine): Difference between revisions
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:XmlDoc:LoadSystemMethodInfo subtitle}} | {{Template:XmlDoc:LoadSystemMethodInfo subtitle}} | ||
This method loads an XmlDoc with information about methods in | This method loads an <var>XmlDoc</var> with information about methods in | ||
classes selected by a "pattern" argument. | 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 | ||
| Line 11: | Line 11: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>doc</th> | <tr><th>doc</th> | ||
<td>An expression that points to the XmlDoc to contain the selected method information. </td></tr> | <td>An expression that points to the <var>XmlDoc</var> to contain the selected method information. </td></tr> | ||
<tr><th>pattern</th> | <tr><th>pattern</th> | ||
<td>A string whose case is ignored and which can have any of the following forms: | <td>A string whose case is ignored and which can have any of the following forms: | ||
| Line 19: | Line 19: | ||
<tr><th><i>classPattern':'methodPattern</i></th> | <tr><th><i>classPattern':'methodPattern</i></th> | ||
<td>This selects, from any system class matching ''classPattern'', all methods which match ''methodPattern''. </td></tr> | <td>This selects, from any system class matching ''classPattern'', all methods which match ''methodPattern''. </td></tr> | ||
<tr><th><i>'System:'classPattern':'methodPattern</i></th> | <tr><th><i>'<var>System</var>:'classPattern':'methodPattern</i></th> | ||
<td>This is the same as ''classPattern':'methodPattern''. </td></tr> | <td>This is the same as ''classPattern':'methodPattern''. </td></tr> | ||
</table> | </table> | ||
| Line 34: | Line 34: | ||
<li>The New method has any arguments. | <li>The New method has any arguments. | ||
</ul> | </ul> | ||
<li>LoadSystemMethodInfo will not display classes in the module LOCAL, | <li><var>LoadSystemMethodInfo</var> will not display classes in the module LOCAL, | ||
if they are selected by a pattern | if they are selected by a pattern | ||
(that is, ''pattern'' contains a wildcard character), or if | (that is, ''pattern'' contains a wildcard character), or if | ||
| 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 Object XmlDoc | %d is <var>Object</var> <var>XmlDoc</var> | ||
%d = New | %d = New | ||
%d:LoadSystemMethodInfo('AddAttribute') | %d:<var>LoadSystemMethodInfo</var>('AddAttribute') | ||
%d:Print | %d:Print | ||
End | End | ||
| Line 57: | Line 57: | ||
<method name="ADDATTRIBUTE" type="function" callable="yes"> | <method name="ADDATTRIBUTE" type="function" callable="yes"> | ||
<result> | <result> | ||
<type name="Object" class="XMLNODE"/> | <type name="<var>Object</var>" class="XMLNODE"/> | ||
</result> | </result> | ||
<arg> | <arg> | ||
<type name="Longstring"/> | <type name="<var>Longstring</var>"/> | ||
</arg> | </arg> | ||
<arg> | <arg> | ||
<type name="Longstring"/> | <type name="<var>Longstring</var>"/> | ||
</arg> | </arg> | ||
<arg optional="yes"> | <arg optional="yes"> | ||
<type name="Longstring"/> | <type name="<var>Longstring</var>"/> | ||
</arg> | </arg> | ||
</method> | </method> | ||
Revision as of 17:46, 25 January 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:
|
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>