LoadSystemMethodInfo (XmlDoc subroutine): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (edits, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:XmlDoc:LoadSystemMethodInfo subtitle}} | {{Template:XmlDoc:LoadSystemMethodInfo subtitle}} | ||
<var>LoadSystemMethodInfo</var> loads an <var>XmlDoc</var> 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== | ==Syntax== | ||
{{Template:XmlDoc:LoadSystemMethodInfo syntax}} | {{Template:XmlDoc:LoadSystemMethodInfo syntax}} | ||
| Line 11: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>doc</th> | <tr><th>doc</th> | ||
<td>An expression that points to the <var>XmlDoc</var> 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: | ||
<table class="syntaxNested"> | <table class="syntaxNested"> | ||
<tr><th>methodPattern</th> | <tr><th>methodPattern</th> | ||
<td>This selects, from any system class, all methods which match the specified pattern. </td></tr> | <td>This selects, from any system class, all methods which match the specified pattern.</td></tr> | ||
<tr><th>classPattern':'methodPattern</th> | <tr><th>classPattern':'methodPattern</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>'<var>System</var>:'classPattern':'methodPattern</th> | <tr><th>'<var>System</var>:'classPattern':'methodPattern</th> | ||
<td>This is the same as ''classPattern':'methodPattern''. </td></tr> | <td>This is the same as ''classPattern':'methodPattern''. </td></tr> | ||
</table> | </table></td></tr> | ||
</td></tr> | <tr><th>showBase</th> | ||
<td>A [[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]] that selects whether ...</td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The "New" method will only be displayed if either is | <li>The "New" method will only be displayed if either is true: | ||
true: | |||
<ul> | <ul> | ||
<li>The ''methodPattern'' is the string < | <li>The ''methodPattern'' is the string <code>New</code>. | ||
<li>The New method has any arguments. | <li>The New method has any arguments. | ||
</ul> | </ul> | ||
<li><var>LoadSystemMethodInfo</var> 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 (that is, ''pattern'' contains a wildcard character), or if there is no ''classPattern'' component. | ||
if they are selected by a pattern | |||
(that is, ''pattern'' contains a wildcard character), or if | |||
there is no ''classPattern'' component. | |||
</ul> | </ul> | ||
== | ==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"> | <p class="code">begin | ||
%d is | %d is object xmlDoc | ||
%d = | %d = new | ||
%d: | %d:loadSystemMethodInfo('AddAttribute') | ||
%d: | %d:print | ||
end | |||
</p> | </p> | ||
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"> | ||
| Line 72: | Line 64: | ||
</class> | </class> | ||
</classes> | </classes> | ||
</p> | </p></ol> | ||
==See also== | ==See also== | ||
{{Template:XmlDoc:LoadSystemMethodInfo footer}} | {{Template:XmlDoc:LoadSystemMethodInfo footer}} | ||
Revision as of 10:29, 19 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:
| ||||||
| showBase | A "Boolean Enumeration" that selects whether ... |
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.
- The methodPattern is the string
- 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>