AppendProcedureList (Stringlist function): Difference between revisions

Revision as of 03:35, 25 January 2011

Add information about procedures to a Stringlist (Stringlist class)

This callable function returns information about procedures in a procedure file or group into a Stringlist.

The AppendProcedureList function accepts three arguments and returns a numeric result.

Syntax

[%rc =] sl:AppendProcedureList( file, [pname], [accnt], [date])

Syntax terms

%rc

A numeric variable that is set to zero if the function is a success; otherwise, it is set to one of these negative error codes:.

-1	File/group not found
-2	No procedures match search criteria

All other errors result in request cancellation.

sl

A Stringlist object.

file

The name of the file or group for which information is to be returned. This is an optional argument, and it defaults to the default file/group at compile time.

pname

The procedure name that is to be selected. The procedure name may contain asterisk (*) characters to indicate wildcard matches. This is an optional parameter, and it defaults to all procedures.

accnt

The account ID of the last modifying user for the procedures to be selected. The account ID may contain asterisk (*) characters to indicate wildcard matches. This is an optional parameter, and it defaults to all account IDs.

date

A string indicating the last modification date for the procedures to be selected. If specified, this parameter must be six bytes long and begin with an equal sign (=), a less-than sign (<), or a greater-than sign (>) to indicate whether the date should be equal to, less than, or greater than, respectively, the Julian date that follows, which is the last five characters. For example: the value >03200 selects procedures last modified after day 200 of 2003.

This is an optional parameter, and it defaults to all modification dates.

This two-digit year date is interpreted with a CENTSPAN of 1975, so values between 00000 and 74365 are considered to be in the year range 2000-2074.

Usage notes

%sl, the output Stringlist produced by AppendProcedureList, has the following format:

Col 1-10: Account ID of last updater.
Col 12-19: Size of procedure in bytes.
Col 21-30: Date of last update (YYYY/MM/DD).
Col 32-39: Time of last update (BH:MI:SS).
Col 41-48: File containing the procedure.
Col 49-: Procedure name.

Examples

The following program displays information for all procedures in group HOMER beginning with the letter S, last updated by a user whose account ID begins with the letter A.

b %list is object stringList %list = new %list:appendProcedureList('HOMER', 'S*', 'A*') %list:print end

@@ Line 17: / Line 17: @@
 <td>No procedures match search criteria</td></tr>
 </table>
-<p class="code">All other errors result in request cancellation.</td></tr>
+All other errors result in request cancellation.
-</p>
 <tr><th>sl</th>
 <td>A <var>Stringlist</var> object.</td></tr>
 <tr><th>file</th>
-<td>The name of the file or group for which information is to be returned. This is an optional argument, and it defaults to the default file/group at compile time.</td></tr>
+<td>The name of the file or group for which information is to be returned. This is an optional argument, and it defaults to the default file/group at <b><i>compile</i></b> time.</td></tr>
 <tr><th>pname</th>
 <td>The procedure name that is to be selected. The procedure name may contain asterisk (*) characters to indicate wildcard matches. This is an optional parameter, and it defaults to all procedures.</td></tr>
@@ Line 28: / Line 27: @@
 <td>The account ID of the last modifying user for the procedures to be selected. The account ID may contain asterisk (*) characters to indicate wildcard matches. This is an optional parameter, and it defaults to all account IDs.</td></tr>
 <tr><th>date</th>
-<td>A string indicating the last modification date for the procedures to be selected. If specified, this parameter must be six bytes long and begin with an equal sign (=), a less-than sign (<), or a greater-than sign (>) to indicate whether the date should be equal to, less than, or greater than, respectively, the Julian date that follows, which is the last five characters. For example, the value <tt>.>03200</tt> selects procedures last modified after day 200 of 2003. This is an optional parameter, and it defaults to all modification dates.
+<td>A string indicating the last modification date for the procedures to be selected. If specified, this parameter must be six bytes long and begin with an equal sign (=), a less-than sign (<), or a greater-than sign (>) to indicate whether the date should be equal to, less than, or greater than, respectively, the Julian date that follows, which is the last five characters.  For example: the value<var class="term"> >03200</var class="term"> selects procedures last modified after day 200 of 2003.
-<p class="code">This two-digit year date is interpreted with a CENTSPAN of 1975, so values between 00000 and 74365 are considered to be in the year range 2000-2074.</td></tr>
+This is an optional parameter, and it defaults to all modification dates.
-</p>
+This two-digit year date is interpreted with a CENTSPAN of 1975, so values between 00000 and 74365 are considered to be in the year range 2000-2074.</td></tr>
 </table>
 ==Usage notes==
-'''%sl''', the output <var>Stringlist</var> produced by <var>AppendProcedureList</var>, has the following format:<dl>
+<var class="term">%sl</var class="term">, the output <var>Stringlist</var> produced by <var>AppendProcedureList</var>, has the following format:<dl>
 <dt>Col 1-10<dd>Account ID of last updater.<dt>Col 12-19<dd>Size of procedure in bytes.<dt>Col 21-30<dd>Date of last update (YYYY/MM/DD).<dt>Col 32-39<dd>Time of last update (BH:MI:SS).<dt>Col 41-48<dd>File containing the procedure.<dt>Col 49-<dd>Procedure name.</dl>