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 the date and time when the object was filed as the Start-value for ascending or descending date order. When a Start-value is specified, you can also specify an End-value.
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.
The timezone is always GMT. Other timezones are not considered.
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. Date and time on which the object was filed (yyyymmddhhmm) for ascending or descending date order. | |
| End-value | A32 | O | Object name for user-defined sequence. Date and time on which the object was filed (yyyymmddhhmm) for ascending or descending date order. When Folder-sequence is 1, End-value must be bigger than or equal to Start-value. When Folder-sequence is 2, End-value must be less than or equal to Start-value. | |
| 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 | P10 | 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. | |
| Name-sent-to/by | A20 | X | When the item is stored in the Inbasket or has been filed from the Inbasket, this is the name of the sender. When the item is stored in the Outbasket or has been filed from 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). | |
| Mailtype | A1 | X | For items that are stored in the Inbasket or have been filed from the Inbasket: 1=received mail item, 2=forwarded mail item, 3=reply. For items that are stored in the Outbasket or have been filed from the Outbasket: 4=sent mail item, 5=forwarded mail item, 6=reply. This field is blank for items that have not been mailed. | |
| Enclosures-number | N3 | X | The number of enclosures. | |
| Private-flag | A1 | X | If marked, the item is a private object. | |
| Author-ID | A8 | X | The name of the cabinet in which the item was created. | |
| Modified-ID | A8 | X | The name of the cabinet in which the item was last modified. | |
| Creation-date | A8 | X | The date on which the item was created (yyyymmdd). | |
| Creation-time | A4 | X | The time the item was created (hhmm). | |
| Modified-date | A8 | X | The date on which the item was last modified (yyyymmdd). | |
| Modified-time | A4 | X | The time the item was last modified (hhmm). | |
| Mailed-date | A8 | X | The date on which the item was last mailed (yyyymmdd). Example: when the item was sent and then forwarded, the forwarding date is shown. | |
| Mailed-time | A4 | X | The time the item was last mailed (hhmm). | |
| Filed-date | A8 | X | The date on which the item was filed (yyyymmdd). | |
| Filed-time | A4 | X | The time the item was filed (hhmm). | |
| Work-parameter | A81 | 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 |
| 90 | Incorrect Start-value and/or End-value |
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-754
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 2 START-TIME (A4) 0150 1 END-VALUE (A32) 0160 1 REDEFINE END-VALUE 0170 2 END-DATE (A8) 0180 2 END-TIME (A4) 0190 1 NUMBER (N2) 0200 1 OBJECT-TABLE (20) 0210 2 ISN (P10) 0220 2 OBJECT-NAME (A32) 0230 2 DESCRIPTION (A60) 0240 2 OBJECT-NO (N2) 0250 2 DOCUMENT-FORMAT (A1) 0260 2 STORED-IN-FILE (A15) 0270 2 ITEMS (A1) 0280 2 NAME-SENT-TO/BY (A20) 0290 2 MAILCOUNT (N7) 0300 2 MAILTYPE (A1) 0310 2 ENCLOSURES-NUMBER (N3) 0320 2 PRIVATE-FLAG (A1) 0330 2 AUTHOR-ID (A8) 0340 2 MODIFIED-ID (A8) 0350 2 CREATION-DATE (A8) 0360 2 CREATION-TIME (A4) 0370 2 MODIFIED-DATE (A8) 0380 2 MODIFIED-TIME (A4) 0390 2 MAILED-DATE (A8) 0400 2 MAILED-TIME (A4) 0410 2 FILED-DATE (A8) 0420 2 FILED-TIME (A4) 0430 1 WORK-PARAMETER (A81) 0440 1 MAIL-TYPE-TEXT (A2/1:20) 0450 1 INX (N2) 0460 END-DEFINE 0470 * 0480 MOVE 'AH' TO CABINET 0490 MOVE 'AH' TO PASSWORD 0500 MOVE 'WORK' TO FOLDER-NAME 0510 MOVE 11 TO OBJECT-NUMBER /* Display documents only 0520 MOVE 1 TO FOLDER-SEQUENCE 0530 MOVE '19980101' TO START-DATE 0540 MOVE '0000' TO START-TIME 0550 MOVE '19990101' TO END-DATE 0560 MOVE '0000' TO END-TIME 0570 * 0580 REPEAT UNTIL RETURN-CODE EQ 77 0590 * 0600 CALLNAT 'Z-DIS13B' RETURN-CODE CABINET PASSWORD FOLDER-NAME 0610 FILE-NAME FOLDER-NUMBER FILE-NUMBER OBJECT-NUMBER FOLDER-SEQUENCE 0620 START-VALUE END-VALUE NUMBER OBJECT-TABLE (*) WORK-PARAMETER 0630 * 0640 IF NOT RETURN-CODE = 0 OR = 77 0650 WRITE 'Return code' RETURN-CODE 0660 STOP 0670 END-IF 0680 * 0690 FOR INX 1 20 0700 DECIDE ON FIRST VALUE OF MAILTYPE(INX) 0710 VALUE '1' MOVE 'I<' TO MAIL-TYPE-TEXT(INX) 0720 VALUE '2' MOVE 'F<' TO MAIL-TYPE-TEXT(INX) 0730 VALUE '3' MOVE 'R<' TO MAIL-TYPE-TEXT(INX) 0740 VALUE '4' MOVE 'O>' TO MAIL-TYPE-TEXT(INX) 0750 VALUE '5' MOVE 'F>' TO MAIL-TYPE-TEXT(INX) 0760 VALUE '6' MOVE 'R>' TO MAIL-TYPE-TEXT(INX) 0770 NONE VALUE MOVE ' ' TO MAIL-TYPE-TEXT(INX) 0780 END-DECIDE 0790 END-FOR 0800 * 0810 DISPLAY OBJECT-NAME(*) FILED-DATE(*) FILED-TIME(*) MAIL-TYPE-TEXT(*) 0820 * 0830 END-REPEAT 0840 * 0850 END