This document covers the following topics:
Display the contents of a specific folder or file.
You can specify a folder or file by either its name or its number. You must not specify both. You can invoke Z-DIS13 prior to this subprogram to return the number of the desired folder.
When you specify a folder and do not specify a file, only the contents of the specified folder is shown. When you specify a folder and a file, only the contents of the specified file is shown.
Exception: for the Inbasket, the contents of all files is shown, if you do not specify a file.
The following applies to invitations in the Inbasket: if the originator has modified a meeting and sent the invitations, only the most recent modified invitations are displayed in the attendee's Inbaskets.
The following applies to mail items in the Inbasket: when the specified expiration date and time has been reached, the mail item is automatically deleted from the Inbasket of each addressee who has not yet read the mail item.
You can specify an object name as the Start-value for user-defined sequence; or an object date as the Start-value for ascending or descending date order.
Note:
When you specify a start date and the date order is descending,
folders and files are not returned. Entering a file name as a Start-value for
user-defined sequence does not function.
This subprogram should be invoked iteratively until the return code 77 indicates the end of the list. In this case, the parameters cannot be modified once this subprogram has been invoked. If this subprogram is invoked iteratively, the Work-parameter contains the needed restart values.
| Parameter | Format | In | Out | Remarks |
|---|---|---|---|---|
| Return-code | N2 | O | X | Input -1: no ET. |
| Cabinet | A8 | R | The name of the cabinet in which you want to display the folder/file contents. | |
| Password | A8 | R | The password of the above cabinet. | |
| Folder-name | A15 | R* | The name of the folder for which you want to display the contents. Either Folder-name or Folder-number, not both. | |
| File-name | A15 | O* | The name of the file for which you want to display the contents. Either File-name or File-number, not both. | |
| Folder-number | N5 | R* | The internal number of the folder for which you want to display the contents. Either Folder-number or Folder-name, not both. See Folder Numbers. | |
| File-number | N5 | O* | The internal number of the file for which you want to display the contents. Either File-number or File-name, not both. See File Numbers. | |
| Object-number | N2 | O | If you specify an object number, only the objects corresponding to that number are returned. If you specify 0, all objects in the folder/file are returned. See Object Numbers. | |
| Folder-sequence | N1 | O | The sequence in which the folder or file contents is to be returned. 1=ascending by date, 2=descending by date, or 3=user-defined. Default: 1. | |
| Start-value | A32 | O | Object name for user-defined sequence. Object date (yyyymmdd) for ascending or descending date order. | |
| Number | N2 | O | The maximum number of objects that are returned with each call. When you do not specify a value, or when you specify a value greater than 20, the default value 20 is used. | |
| Object-table (20) | ||||
| ISN | P8 | X | The ISN of the object. | |
| Object-name | A32 | X | The name of the object. | |
| Description | A60 | X | The first line of the description. | |
| Object-no | N2 | X | See Object Numbers. | |
| Document-format | A1 | X | Applies if the object is a document. See Document Formats. | |
| Stored-in-file | A15 | X | The name of the file in which the object is stored. If the object is a file, this parameter is blank. | |
| Items | A1 | X | If marked, the folder or file contains objects. However, if a folder only contains empty files, this parameter is not marked. | |
| Object-date | N8 | X | The date, the object was created or mailed. | |
| Name-sent-to/by | A20 | X | When the item is filed in the Inbasket, this is the name of the sender. When the item is filed in the Outbasket, this is the name of the first addressee. | |
| Mailcount | N7 | X | When the item is filed in the Outbasket, this is the number of addressees to whom the item was sent. 0 may also mean that the recipient list was only validated (the item has not been sent). | |
| Work-parameter | A49 | For internal use. See The Work Parameter. | ||
| 00 | Success |
| 02 | Invalid cabinet name or - in batch mode only - locked cabinet |
| 03 | Password incorrect |
| 11 | Supply folder/file name or number, not both |
| 55 | Requested folder/file does not exist |
| 73 | Invalid folder/file name |
| 77 | End of list |
Z-0420
Z-0420A
Z-100
Z-110
Z-120
Z-122
Z-123
Z-147
Z-150
Z-157
Z-165
Z-175
Z-180
Z-190
Z-194
Z-197
Z-222
Z-223
Z-400
Z-401
Z-711
Z-728
Z-729
Z-734
Z-735
Z-736
Z-737
Z-1200&0
0010 DEFINE DATA LOCAL 0020 1 RETURN-CODE (N2) 0030 1 CABINET (A8) 0040 1 PASSWORD (A8) 0050 1 FOLDER-NAME (A15) 0060 1 FILE-NAME (A15) 0070 1 FOLDER-NUMBER (N5) 0080 1 FILE-NUMBER (N5) 0090 1 OBJECT-NUMBER (N2) 0100 1 FOLDER-SEQUENCE (N1) 0110 1 START-VALUE (A32) 0120 1 REDEFINE START-VALUE 0130 2 START-DATE (A8) 0140 1 NUMBER (N2) 0150 1 OBJECT-TABLE (20) 0160 2 ISN (P8) 0170 2 OBJECT-NAME (A32) 0180 2 DESCRIPTION (A60) 0190 2 OBJECT-NO (N2) 0200 2 DOCUMENT-FORMAT (A1) 0210 2 STORED-IN-FILE (A15) 0220 2 ITEMS (A1) 0230 2 OBJECT-DATE (N8) 0240 2 NAME-SENT-TO/BY (A20) 0250 2 MAILCOUNT (N7) 0260 1 WORK-PARAMETER (A49) 0270 * 0280 END-DEFINE 0290 * 0300 MOVE 'AH' TO CABINET 0310 MOVE 'AH' TO PASSWORD 0320 MOVE 'WORK' TO FOLDER-NAME 0330 MOVE 11 TO OBJECT-NUMBER /* Display documents only 0340 MOVE 1 TO FOLDER-SEQUENCE 0350 MOVE '19930101' TO START-DATE 0360 * 0370 REPEAT UNTIL RETURN-CODE EQ 77 0380 * 0390 CALLNAT 'Z-DIS13A' RETURN-CODE CABINET PASSWORD FOLDER-NAME 0400 FILE-NAME FOLDER-NUMBER FILE-NUMBER OBJECT-NUMBER FOLDER-SEQUENCE 0410 START-VALUE NUMBER OBJECT-TABLE (*) WORK-PARAMETER 0420 * 0430 IF NOT RETURN-CODE = 0 OR = 77 0440 WRITE 'Return code' RETURN-CODE 0450 STOP 0460 END-IF 0470 * 0480 DISPLAY OBJECT-NAME(*) OBJECT-DATE(*) DOCUMENT-FORMAT(*) 0490 * 0500 END-REPEAT 0510 * 0520 END