New (ProcedureInfo constructor): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:ProcedureInfo:New subtitle}} | {{Template:ProcedureInfo:New subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:ProcedureInfo:New syntax}} | {{Template:ProcedureInfo:New syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%outProcedureInfo</th><td> | <tr><th>%outProcedureInfo</th> | ||
<td>A <var>ProcedureInfo</var> object variable. If the procedure identified by this method's parameters is not found, <var>New</var> returns a <var>Null</var> object.</td></tr> | |||
<tr><th><var>[%(ProcedureInfo):]</var></th> | <tr><th><var>[%(ProcedureInfo):]</var></th> | ||
<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. | <td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>ProcedureInfo</var> <var>Constructor</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 whose information is being extracted. 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 required, name required, parameter is a case-sensitive string that contains the exact name of the procedure whose information is being extracted.</td></tr> | ||
</table> | </table> | ||
| Line 23: | Line 28: | ||
%procInf = %procInf:new | %procInf = %procInf:new | ||
</p> | </p> | ||
<li>To provide a single display of the information of multiple procedures, you can use the <var>[[List (ProcedureInfo function)|List]]</var> method. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:ProcedureInfo:New footer}} | {{Template:ProcedureInfo:New footer}} | ||
Revision as of 00:08, 22 June 2012
Create a new ProcedureInfo instance (ProcedureInfo class)
[Introduced in Sirius Mods 7.8]
Syntax
%procedureInfo = [%(ProcedureInfo):]New( In= string, Name= string)
Syntax terms
| %outProcedureInfo | A ProcedureInfo object variable. If the procedure identified by this method's parameters is not found, New returns a Null object. |
|---|---|
| [%(ProcedureInfo):] | The optional class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking a ProcedureInfo Constructor. |
| In | This required, name required parameter is a string that specifies the file or group that contains the procedure whose information is being extracted. To access a group, use the keyword Group after In: In Group mygroup. |
| Name | This required, name required, parameter is a case-sensitive string that contains the exact name of the procedure whose information is being extracted. |
Usage notes
- As described in "Using New or other Constructors", New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:
%procInf = new %procInf = %(ProcedureInfo):new %procInf = %procInf:new
- To provide a single display of the information of multiple procedures, you can use the List method.