This document covers the following topics:
Return information about a reference document.
When you return information for a reference document which is currently stored in the Inbasket file New, the corresponding address list is updated so that the reception status of the reference document indicates that it has been read. Additionally, the reference document is moved from the file New to the file Opened. In this case, END TRANSACTION is automatically issued.
The returned date and time values are based on GMT.
| Parameter | Format | In | Out | Remarks |
|---|---|---|---|---|
| Return-code | N2 | O | X | Input -1: no ET. |
| Cabinet | A8 | R | The cabinet in which the reference document is stored. | |
| Password | A8 | R | The password of the above cabinet. | |
| Ref-document-name | A32 | R* | X | The name of the reference document for which you want to return information. Either Ref-document-name or ISN, not both. |
| ISN | P10 | R* | X | The ISN of the reference document for which you want to return information. Either ISN or Ref-document-name, not both. |
| Description | A60/1:4 | X | The description of the reference document. | |
| Keywords | A15/1:6 | X | Keywords are helpful later when you search for an object. | |
| Title | A60 | X | The title of the work. | |
| Writer | A60 | X | The writer of the work. | |
| Private-flag | A1 | X | If marked, the reference document is a private object. | |
| Security-flags | A4 | X | The security levels for Read, Modify and Copy. Values 0 to 9. The security level for Print (fourth byte) is not used for reference documents. | |
| Folder-name | A15 | X | The folder in which the reference document is stored. | |
| File-name | A15 | X | The file within the above folder in which the reference document is stored. | |
| Date-created | P8 | X | The date when the reference document was created. | |
| Time-created | P4 | X | The time when the reference document was created. | |
| Created-ID | A8 | X | The user ID of the person who has created the reference document. | |
| Date-modified | P8 | X | The date when the reference document was last modified. | |
| Time-modified | P4 | X | The time when the reference document was last modified. | |
| Modified-ID | A8 | X | The user ID of the person who has last modified the reference document. |
| 00 | Success |
| 02 | Invalid cabinet name or - in batch mode only - locked cabinet |
| 03 | Password incorrect |
| 04 | ISN was not found |
| 08 | Supply either ISN or name, not both |
| 09 | ISN does not point to correct object |
| 51 | Invalid name |
| 53 | Requested object does not exist |
Z-120
Z-122
Z-123
Z-175
Z-147
Z-165
Z-175
Z-177
Z-194
Z-197
Z-222
Z-223
Z-400
Z-401
Z-1200&0
0010 DEFINE DATA 0020 * 0030 LOCAL 0040 * 0050 1 RETURN-CODE (N2) 0060 1 CABINET (A8) 0070 1 PASSWORD (A8) 0080 1 REF-DOCUMENT-NAME (A32) 0090 1 ISN (P10) 0100 1 DESCRIPTION (A60/1:4) 0110 1 KEYWORDS (A15/1:6) 0120 1 TITLE (A60) 0130 1 WRITER (A60) 0140 1 PRIVATE-FLAG (A01) 0150 1 SECURITY-FLAGS (A4) 0160 1 FOLDER-NAME (A15) 0170 1 FILE-NAME (A15) 0180 1 DATE-CREATED (P8) 0190 1 TIME-CREATED (P4) 0200 1 CREATED-ID (A8) 0210 1 DATE-MODIFIED (P8) 0220 1 TIME-MODIFIED (P4) 0230 1 MODIFIED-ID (A8) 0240 * 0250 END-DEFINE 0260 * 0270 INPUT (IP=OFF AD=A'_') 0280 'Cabinet ' CABINET 0290 / 'Password ' PASSWORD (AD=N) 0300 / 'Ref. Document ' REF-DOCUMENT-NAME 0310 * 0320 IF REF-DOCUMENT-NAME NE ' ' 0330 CALLNAT 'Z-GET27A' 0340 RETURN-CODE 0350 CABINET 0360 PASSWORD 0370 REF-DOCUMENT-NAME 0380 ISN 0390 DESCRIPTION (*) 0400 KEYWORDS (*) 0410 TITLE 0420 WRITER 0430 PRIVATE-FLAG 0440 SECURITY-FLAGS 0450 FOLDER-NAME 0460 FILE-NAME 0470 DATE-CREATED 0480 TIME-CREATED 0490 CREATED-ID 0500 DATE-MODIFIED 0510 TIME-MODIFIED 0520 MODIFIED-ID 0530 IF RETURN-CODE EQ 0 0540 WRITE NOTITLE 0550 'Display' REF-DOCUMENT-NAME (AD=I) 0560 // 'Description:' / DESCRIPTION (*) 0570 // 'Keywords: ' / KEYWORDS (1:3) / KEYWORDS (4:6) 0580 // 'Title: ' / TITLE 0590 / 'Writer: ' / WRITER 0600 // 'Filed in: ' / FOLDER-NAME FILE-NAME 0610 ELSE 0620 WRITE 'Reference document was not found:' RETURN-CODE 0630 END-IF 0640 END-IF 0650 END