LoadSystemMethodInfo (XmlDoc subroutine) - Revision history

Alan at 13:38, 11 August 2015

2015-08-11T13:38:12Z

← Older revision		Revision as of 13:38, 11 August 2015
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 <var class="product">~~User Language~~</var> products delivered		<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 <var class="product">SOUL</var> products delivered by Rocket Software, and the schema of the document may change from release to release. Users of [[SoulEdit]] (V7.5 and later) can see this method in action via the INFO command which provides introspection into specified methods.
	by ~~Sirius~~ Software, and the schema of the document may change from release to release.

	==Syntax==		==Syntax==
Line 57:		Line 56:
	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" docObject="nod">
	<methods module="JSOPF" offset="~~00000CBC~~">		<methods module="JSOPF" offset="00002038">
	<method name="~~ADDATTRIBUTE~~" type="function" callable="yes">		<method name="AddAttribute" type="function" callable="yes" requiredProdNum="35" desc="Add Attribute to Element node">
	<result>		<result>
	<type name="~~<var>~~Object~~</var>~~" class="~~XMLNODE~~"/>		<type name="Object" class="XmlNode"/>
	</result>		</result>
	<arg>		<arg docArg="name">
	<type name="~~<var>Longstring</var>~~"/>		<type name="Unicode"/>
	</arg>		</arg>
	<arg>		<arg docArg="value">
	<type name="~~<var>Longstring</var>~~"/>		<type name="Unicode"/>
	</arg>		</arg>
	<arg optional="yes">		<arg optional="yes" docArg="uri">
	<type name="~~<var>Longstring</var>~~"/>		<type name="Unicode"/>
	</arg>		</arg>
	</method>		</method>
	</methods>		</methods>
	</class>		</class>
	</classes>		</classes>
	</p>		</p>

JAL at 19:16, 12 November 2014

2014-11-12T19:16:14Z

← Older revision		Revision as of 19:16, 12 November 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	{{Template:XmlDoc:LoadSystemMethodInfo syntax}}		{{Template:XmlDoc:LoadSystemMethodInfo syntax}}

	===Syntax terms===		===Syntax terms===
	<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 that can have any of the following forms:		<td>A string whose case is ignored and that 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 that match the specified pattern.</td></tr>		<td>This selects, from any system class, all methods that match the specified pattern.</td></tr>
	<tr><th>classPattern':'methodPattern</th>
	<td>This selects, from any system class matching ''classPattern'', all methods that match ''methodPattern''. </td></tr>		<tr><th>classPattern<var>:</var>methodPattern</th>
	<tr><th>'<var>System</var>:'classPattern':'methodPattern</th>		<td>This selects, from any system class matching <var class="term">classPattern</var>, all methods that match <var class="term">methodPattern</var>. </td></tr>
	<td>This is the same as ''classPattern':'methodPattern''. </td></tr>
			<tr><th><var>System:</var>classPattern<var>:</var>methodPattern</th>
			<td>This is the same as <var class="term">classPattern<var>:</var>methodPattern</var>. </td></tr>
	</table></td></tr>		</table></td></tr>

	<tr><th><var>ShowBase</var></th>		<tr><th><var>ShowBase</var></th>
	<td>A <var>[[Enumerations#Using_Boolean_enumerations\|Boolean]]</var> enumeration that specifies how to handle base and extension classes:		<td>A <var>[[Enumerations#Using_Boolean_enumerations\|Boolean]]</var> enumeration that specifies how to handle base and extension classes:
	<ul><li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes.<li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes.</ul>This [[Notation conventions for methods#Named parameters\|name required]] argument is new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>		<ul>
			<li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes. </li>

			<li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes. </li>
			</ul>
			This [[Notation conventions for methods#Named parameters\|name required]] argument was new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The <var>New</var> method will only be displayed if either is true:		<li>The <var>New</var> method will only be displayed if either is true:
	<ul>		<ul>
	<li>The ''methodPattern'' is the string <code>New</code>.		<li>The ''methodPattern'' is the string <code>New</code>.</li>
	<li>The <var>New</var> method has any arguments.		<li>The <var>New</var> method has any arguments. </li>
	</ul>		</ul></li>
	<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.
			<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.</li>
	</ul>		</ul>

JAL2 at 16:04, 1 June 2011

2011-06-01T16:04:13Z

← Older revision		Revision as of 16:04, 1 June 2011
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		<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 <var class="product">User Language</var> products delivered
	by Sirius Software, and the schema of the document may change from release to release.		by Sirius Software, and the schema of the document may change from release to release.

Line 10:		Line 10:
	<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 that 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 that 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 that 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></td></tr>		</table></td></tr>
	<tr><th><var>ShowBase</var></th>		<tr><th><var>ShowBase</var></th>
	<td>A <var>[[Enumerations#Using_Boolean_enumerations\|Boolean]]</var> enumeration that specifies how to handle base and ~~extentions~~ classes:		<td>A <var>[[Enumerations#Using_Boolean_enumerations\|Boolean]]</var> enumeration that specifies how to handle base and extension classes:
	<ul><li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes.<li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes.</ul>This [[Notation conventions for methods#Named parameters\|name required]] argument is new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>		<ul><li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes.<li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes.</ul>This [[Notation conventions for methods#Named parameters\|name required]] argument is new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>
	</table>		</table>
Line 26:		Line 26:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The "New" method will only be displayed if either is true:		<li>The <var>New</var> method will only be displayed if either is true:
	<ul>		<ul>
	<li>The ''methodPattern'' is the string <code>New</code>.		<li>The ''methodPattern'' is the string <code>New</code>.
	<li>The New method has any arguments.		<li>The <var>New</var> method has any arguments.
	</ul>		</ul>
	<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.		<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.
Line 35:		Line 35:

	==Examples==		==Examples==
	The following request displays the class data for the AddAttribute method:		The following request displays the class data for the <var>[[AddAttribute (XmlNode function)\|AddAttribute]]</var> method:
	<p class="code">begin		<p class="code">begin
	%d is object xmlDoc		%d is object xmlDoc

JAL2: /* Syntax terms */

2011-05-23T14:51:16Z

Syntax terms

← Older revision		Revision as of 14:51, 23 May 2011
Line 19:		Line 19:
	<td>This is the same as ''classPattern':'methodPattern''. </td></tr>		<td>This is the same as ''classPattern':'methodPattern''. </td></tr>
	</table></td></tr>		</table></td></tr>
	<tr><th>~~showBase~~</th>		<tr><th><var>ShowBase</var></th>
	<td>A <var>[[Enumerations#Using_Boolean_enumerations\|Boolean]]</var> enumeration to ~~control the handling of~~ base and extentions classes:<ul><li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes.<li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes.</ul>This argument is new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>		<td>A <var>[[Enumerations#Using_Boolean_enumerations\|Boolean]]</var> enumeration that specifies how to handle base and extentions classes:
			<ul><li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes.<li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes.</ul>This [[Notation conventions for methods#Named parameters\|name required]] argument is new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>
	</table>		</table>

JAL2: /* Syntax terms */

2011-05-23T14:40:05Z

Syntax terms

← Older revision		Revision as of 14:40, 23 May 2011
Line 20:		Line 20:
	</table></td></tr>		</table></td></tr>
	<tr><th>showBase</th>		<tr><th>showBase</th>
	<td>A [[Enumerations#Using_Boolean_enumerations\|"Boolean ~~Enumeration"~~]] to control the handling of base and extentions classes:<ul><li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes.<li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes.</ul>This argument is new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>		<td>A <var>[[Enumerations#Using_Boolean_enumerations\|Boolean]]</var> enumeration to control the handling of base and extentions classes:<ul><li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes.<li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes.</ul>This argument is new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>
	</table>		</table>

JAL2: /* Examples */

2011-05-23T14:37:35Z

Examples

← Older revision		Revision as of 14:37, 23 May 2011
Line 34:		Line 34:

	==Examples==		==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">begin		<p class="code">begin
Line 64:		Line 63:
	</class>		</class>
	</classes>		</classes>
	</p~~></ol~~>		</p>

	==See also==		==See also==
	{{Template:XmlDoc:LoadSystemMethodInfo footer}}		{{Template:XmlDoc:LoadSystemMethodInfo footer}}

Dme: /* Syntax terms */

2011-05-20T20:25:10Z

Syntax terms

← Older revision		Revision as of 20:25, 20 May 2011
Line 20:		Line 20:
	</table></td></tr>		</table></td></tr>
	<tr><th>showBase</th>		<tr><th>showBase</th>
	<td>A [[Enumerations#Using_Boolean_enumerations\|"Boolean Enumeration"]] ~~that selects whether~~ ...</td></tr>		<td>A [[Enumerations#Using_Boolean_enumerations\|"Boolean Enumeration"]] to control the handling of base and extentions classes:<ul><li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes.<li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes.</ul>This argument is new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>
	</table>		</table>

Goff: edits, tags and links

2011-05-19T10:29:24Z

edits, tags and links

← Older revision		Revision as of 10:29, 19 May 2011
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.

	~~This method 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 <tt>New</tt>.		<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>

	==~~=Example=~~==		==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">~~Begin~~		<p class="code">begin
	%d is ~~Object XmlDoc~~		%d is object xmlDoc
	%d = ~~New~~		%d = new
	%d:~~LoadSystemMethodInfo~~('AddAttribute')		%d:loadSystemMethodInfo('AddAttribute')
	%d:~~Print~~		%d:print
	~~End~~		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}}

Dme at 16:24, 7 February 2011

2011-02-07T16:24:32Z

← Older revision		Revision as of 16:24, 7 February 2011
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}}

Wiccan: 1 revision

2011-02-07T16:12:08Z

1 revision

← Older revision	Revision as of 16:12, 7 February 2011
(No difference)