ROR TASK LIST (1766)    REMOTE PROCEDURE (8994)

Name Value
NAME ROR TASK LIST
TAG TASKLIST
ROUTINE RORRP010
RETURN VALUE TYPE GLOBAL ARRAY
AVAILABILITY RESTRICTED
WORD WRAP ON TRUE
VERSION 1
DESCRIPTION
The ROR TASK LIST remote procedure returns a list of user's tasks 
scheduled from the GUI.
INPUT PARAMETER
  • REGIEN
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The REGIEN parameter should contain a valid registry IEN (IEN of the 
    registry parameters record in the ROR REGISTRY PARAMETERS file #798.1). 
     
    The tasks associated with the provided registry will be returned by the 
    procere. By default ($G(REGIEN)'>0), all tasks are returned.
    
  • TYPE
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    The TYPE parameter defines which tasks (1-Generic, 2-Report) are returned
    by the procedure. See the description of the TYPE field (.02) of the ROR
    TASK file (#798.8) for more details.  By default ($G(TYPE)'>0), all tasks 
    are retrieved.
    
  • USER
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    A user IEN (DUZ) can be assigned to the USER parameter. Only tasks
    scheduled by this user are retrieved by the procedure. By default 
    ($G(USER)'>0), it utilizes the current user's DUZ.
    
RETURN PARAMETER DESCRIPTION
A negative value of the first "^"-piece of the Results[0] indicates that 
  Results[i]            Error Descriptor
                          ^01: Error code
                          ^02: Message
                          ^03: Place of the error
 
Otherwise, the task descriptors are returned in the RESULTS array (see the
ROR TASK INFO remote procedure for details).
 
  Results[0]            Result Descriptor
                          ^01: Number of task descriptors returned
an error occurred during the execution of the remote procedure. In this 
                               in the Results array (NTSK)
                          ^02: Number of nodes that make a single
                               task descriptor (TIN)
 
  Results[i]            Value returned by the $$TASKINFO^RORTSK
                        function. You can calculate the subscript
                        of the item TI (from 1 to TIN) of the task
                        TN (from 1 to NTSK) using the following
                        formula: i = (TN-1)*TIN+TI.
 
case, the second piece of the Results[0] will contain number of the error 
For example, if number of nodes returned by the $$TASKINFO^RORTSK function
for each task is 13 and the RESULTS array contains information about 3
tasks, the following nodes will be defined:
 
  Results[0]  = "3^14"
 
  Results[1]  = Task Number 1
  Results[2]  = Task Type 1 (internal^external)
  ...
  Results[14] = User Comment 1
descriptors returned in the subsequent nodes of the Results array:
 
  Results[15] = Task Number 2
  Results[16] = Task Type 2 (internal^external)
  ...
  Results[28] = User Comment 2
 
  Results[29] = Task Number 3
  Results[30] = Task Type 3 (internal^external)
  ...
  Results[42] = User Comment 3
 
  Results[0]            Result Descriptor
                          ^01: The last error code
                          ^02: Number of the error descriptors