List (ProcedureInfo function): Difference between revisions

Revision as of 19:34, 21 June 2012

Get list of procedures (ProcedureInfo class)

[Introduced in Sirius Mods 7.8]

%procedureInfoList = %(ProcedureInfo):List( In= string, [Name= string])

%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.
`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.

@@ Line 13: / Line 13: @@
 <tr><th><var>In</var></th>
-<td>This [[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.</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.</td></tr>
 <tr><th><var>Name</var></th>
-<td>This name required parameter is a 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>

ProcedureInfo class	List of ProcedureInfo methods	ProcedureInfo methods syntax
Notation conventions for methods