$Proc ListG: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
(Automatically generated page update)
Line 2: Line 2:
<span class="pageSubtitle">$list of information about procedures in group or file</span>
<span class="pageSubtitle">$list of information about procedures in group or file</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Proc_ListG function is the [[AppendProcedureList (Stringlist function)]].</p>
<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Proc_ListG function is the [[AppendProcedureList (Stringlist function)]].</p>


This function returns information about procedures in a procedure file or group into a $list. This function is virtually identical to <var>[[$Proc_List]]</var>. The main difference between <var>$Proc_List</var> and <var>$Proc_ListG</var> is that <var>$Proc_ListG</var> returns the name of the file containing the procedure. This is useful if <var>$Proc_ListG</var> is invoked against a procedure group.  
This function returns information about procedures in a procedure file or group into a $list. This function is virtually identical to <var>[[$Proc_List]]</var>. The main difference between <var>$Proc_List</var> and <var>$Proc_ListG</var> is that <var>$Proc_ListG</var> returns the name of the file containing the procedure. This is useful if <var>$Proc_ListG</var> is invoked against a procedure group.  

Revision as of 01:32, 19 July 2013

$list of information about procedures in group or file

Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Proc_ListG function is the AppendProcedureList (Stringlist function).

This function returns information about procedures in a procedure file or group into a $list. This function is virtually identical to $Proc_List. The main difference between $Proc_List and $Proc_ListG is that $Proc_ListG returns the name of the file containing the procedure. This is useful if $Proc_ListG is invoked against a procedure group.

Also see $PrcLExG, which returns the date of last update with a 4-digit year.

The $Proc_ListG function accepts four arguments and returns a numeric result.

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

The second argument is the procedure name that is to be selected. The procedure name may contain '*' characters to indicate wildcard matches. This is an optional parameter and defaults to all procedures.

The third argument is the account id of the last modifying user for the procedures to be selected. The account id may contain '*' characters to indicate wildcard matches. This is an optional parameter and defaults to all account ids.

The fourth argument is a string indicating the last modification date for the procedures to be selected. If specified, this parameter must be 6 bytes long and begin with either a '=', '<' or '>' character to indicate whether the date should be equal to, less than or greater than the following Julian date which is the last 5 characters. '>89200', for example, selects procedures last modified after day 200 of 1989. This is an optional parameter and defaults to all modification dates. Note that this 2-digit year date is interpreted with a CENTSPAN of 1975, so that values between 00000 and 74365 are considered to be in the years 2000-2074.

Syntax

%result = $Proc_ListG(file, pname, account, date)

%result is a either a $list identifier or a negative error code.

All invocations of a particular call to $Proc_ListG will always return the same $list identifier. Each time that call is executed, if the function is successful then any previous $list created by that call is deleted, and a new list is created.

The output $list produced by $Proc_ListG 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 proc.
Col 49- Procedure name

-1 - File/group not found -2 - No procedures match search criteria -3 - No room to create $list items (if LISTFC $SirParm parameter not set) -4 - Invalid selection criterion

$Proc_ListG Error Codes

Example

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 = $Proc_ListG('HOMER', 'S*', 'A*') FOR %I FROM 1 TO $ListCnt(%LIST) PRINT $ListInf(%LIST, %I) END FOR END

Products authorizing $Proc_ListG