List (ProcedureInfo function): Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
(Automatically generated page update) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:ProcedureInfo:List subtitle}} | {{Template:ProcedureInfo:List subtitle}} | ||
This | This method returns the information of one, many, or all procedures in a specified procedure file or group. | ||
==Syntax== | ==Syntax== | ||
{{Template:ProcedureInfo:List syntax}} | {{Template:ProcedureInfo:List syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%procedureInfoList</th><td><var> | <tr><th>%procedureInfoList</th> | ||
<tr><th>(ProcedureInfo)</th> | <td>An <var>Arraylist of Object ProcedureInfo</var> object variable.</td></tr> | ||
<td>The class name in parentheses denotes a shared method. List can also be invoked via a ProcedureInfo object variable, which may be <var>Null</var>.</td></tr> | |||
<tr><th><var class="nobr">%(ProcedureInfo)</var></th> | |||
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. List can also be invoked via a <var>ProcedureInfo</var> object variable, which may be <var>Null</var>.</td></tr> | |||
<tr><th><var>In</var></th> | <tr><th><var>In</var></th> | ||
<td>string</td></tr> | <td>This required, [[Notation conventions for methods#Named members|name required]] parameter is a string that specifies the file or group that contains the procedure(s) to be listed. To access a group, use the keyword <var>Group</var> after <var>In</var>: <code>In Group <i>mygroup</i></code>.</td></tr> | ||
<tr><th><var>Name</var></th> | <tr><th><var>Name</var></th> | ||
<td>string</td></tr> | <td>This optional, name required, parameter is a string that identifies the procedure(s) whose information will be returned. The string may contain standard, non-regex, <var class="product">User Language</var> wildcards. | ||
<p> | |||
Specifying no <var>Name</var> value is the same as specifying an asterisk (<tt>*</tt>), which returns information for all the procedures. </p></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>The <var>List</var> method does not have parameters to select procedures based on last update time or last updating user ID. You can accomplish the same thing by using the <var>Arraylist</var> subsetting methods, though this approach would be significantly more expensive if a large list were built only to select a small subset. | |||
</ul> | |||
==Examples== | ==Examples== | ||
See the <var>ProcedureInfo</var> class [[ProcedureInfo class#Example|"Example"]]. | |||
==See also== | ==See also== | ||
{{Template:ProcedureInfo:List footer}} | {{Template:ProcedureInfo:List footer}} | ||
Latest revision as of 00:56, 16 February 2014
Get list of procedures (ProcedureInfo class)
[Introduced in Sirius Mods 7.8]
This method returns the information of one, many, or all procedures in a specified procedure file or group.
Syntax
%procedureInfoList = %(ProcedureInfo):List( In= string, [Name= string])
Syntax terms
| %procedureInfoList | An Arraylist of Object ProcedureInfo object variable. |
|---|---|
| %(ProcedureInfo) | The class name in parentheses denotes a shared method. List can also be invoked via a ProcedureInfo object variable, which may be Null. |
| In | This required, name required parameter is a string that specifies the file or group that contains the procedure(s) to be listed. To access a group, use the keyword Group after In: In Group mygroup. |
| Name | This optional, name required, parameter is a string that identifies the procedure(s) whose information will be returned. The string may contain standard, non-regex, User Language wildcards.
Specifying no Name value is the same as specifying an asterisk (*), which returns information for all the procedures. |
Usage notes
- The List method does not have parameters to select procedures based on last update time or last updating user ID. You can accomplish the same thing by using the Arraylist subsetting methods, though this approach would be significantly more expensive if a large list were built only to select a small subset.
Examples
See the ProcedureInfo class "Example".