This document covers the following topics:
Return the document information.
This subprogram is the same as Z-IN11G2 with the one exception that the parameter ISN uses the format P10.
To update the document information, you must use Z-IN11UX. To return the text of the document, you must use Z-GET11C.
| Parameter | Format | In | Out | Remarks |
|---|---|---|---|---|
| Return-code | N2 | O | X | Input -1: no ET. |
| Cabinet | A8 | R | The cabinet in which the document information is to be returned. | |
| Password | A8 | R | The password of the above cabinet. | |
| Document-name | A32 | R* | The name of the document for which you want to return the document information. Either Document-name or ISN, not both. | |
| ISN | P10 | R* | X | The ISN of the document for which you want to return the document information. Input: either ISN or Document-name, not both. You can invoke Z-DIS11X prior to this subprogram to obtain the ISN for the desired document. |
| Description | A60/1:4 | X | The description of the document. | |
| Keywords | A15/1:6 | X | Keywords are helpful when you search for an object. | |
| Private-flag | A1 | X | If marked, this is a private document. | |
| Security-flags | A4 | X | The security levels for Read, Modify, Copy and Print. Values 0 to 9. | |
| Formatting-profile | A32 | X | The name of the formatting profile. | |
| Pre-format-procedures | A32/1:4 | X | The names of the pre-formatting procedures. | |
| Post-format-procedures | A32/1:4 | X | The names of the post-formatting procedures. | |
| Folder-name | A15 | X | The folder in which the document is stored. | |
| File-name | A15 | X | The file within the above folder in which the document is stored. | |
| TRS-document-flag | A1 | X | If marked, the document is a TRS document. | |
| Document-format | A1 | X | See Document Formats. | |
| Enclosures | N2 | X | The number of enclosures. | |
| Attached-notes | N2 | X | The number of attached notes and cover notes. | |
| Created-ID | A8 | X | The user ID of the person who has created the document. | |
| Date-created | N8 | X | The date when the document was created. | |
| Time-created | N4 | X | The time when the document was created. | |
| Modified-ID | A8 | X | The user ID of the person who has last modified the document. | |
| Date-modified | N8 | X | The date when the document was last modified. | |
| Time-modified | N4 | X | The time when the document was last modified. | |
| Mailed-ID | A16 | X | The user ID of the person who has sent the document to this cabinet. | |
| Date-mailed | N8 | X | The date when the document was mailed. | |
| Time-mailed | N4 | X | The time when the document was mailed. | |
| Forwarded-ID | A16 | X | The user ID of the person who has forwarded the document to this cabinet. | |
| Date-forwarded | N8 | X | The date when the document was forwarded. | |
| Time-forwarded | N4 | X | The time when the document was forwarded. | |
| Replied-ID | A16 | X | The user ID of the person who has sent this document as a reply. | |
| Date-replied | N8 | X | The date when the reply was sent. | |
| Time-replied | N4 | X | The time when the reply was sent. | |
| Expiration-date | N8 | X | The expiration date of the document. Format yyyymmdd. | |
| Archive-flag | A1 | X | If marked, the document is stored on some other medium (e.g. on tape) when the expiration date is reached. |
| 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-147
Z-1200&0
0010 * 0020 * Example program to return the document information. 0030 * 0040 DEFINE DATA 0050 LOCAL 0060 1 RETURN-CODE (N2) 0070 1 CABINET (A8) 0080 1 PASSWORD (A8) 0090 1 DOCUMENT-NAME (A32) 0100 1 ISN (P10) 0110 1 DESCRIPTION (A60/1:4) 0120 1 KEYWORDS (A15/1:6) 0130 1 PRIVATE-FLAG (A1) 0140 1 SECURITY-FLAGS (A4) 0150 1 FORMATTING-PROFILE (A32) 0160 1 PRE-FORMAT-PROCEDURES (A32/1:4) 0170 1 POST-FORMAT-PROCEDURES (A32/1:4) 0180 1 FOLDER-NAME (A15) 0190 1 FILE-NAME (A15) 0200 1 TRS-DOCUMENT-FLAG (A1) 0210 1 DOCUMENT-FORMAT (A1) 0220 1 ENCLOSURES (N2) 0230 1 ATTACHED-NOTES (N2) 0240 1 CREATED-ID (A8) 0250 1 DATE-CREATED (N8) 0260 1 TIME-CREATED (N4) 0270 1 MODIFIED-ID (A8) 0280 1 DATE-MODIFIED (N8) 0290 1 TIME-MODIFIED (N4) 0300 1 MAILED-ID (A16) 0310 1 DATE-MAILED (N8) 0320 1 TIME-MAILED (N4) 0330 1 FORWARDED-ID (A16) 0340 1 DATE-FORWARDED (N8) 0350 1 TIME-FORWARDED (N4) 0360 1 REPLIED-ID (A16) 0370 1 DATE-REPLIED (N8) 0380 1 TIME-REPLIED (N4) 0390 1 EXPIRATION-DATE (N8) 0400 1 ARCHIVE-FLAG (A1) 0410 * 0420 END-DEFINE 0430 * 0440 RESET RETURN-CODE 0450 MOVE 'CABINET' TO CABINET 0460 MOVE 'PASSWORD' TO PASSWORD 0470 MOVE 1234567890 TO ISN 0480 * 0490 CALLNAT 'Z-IN11GX' 0500 RETURN-CODE 0510 CABINET 0520 PASSWORD 0530 DOCUMENT-NAME 0540 ISN 0550 DESCRIPTION(*) 0560 KEYWORDS(*) 0570 PRIVATE-FLAG 0580 SECURITY-FLAGS 0590 FORMATTING-PROFILE 0600 PRE-FORMAT-PROCEDURES(*) 0610 POST-FORMAT-PROCEDURES(*) 0620 FOLDER-NAME 0630 FILE-NAME 0640 TRS-DOCUMENT-FLAG 0650 DOCUMENT-FORMAT 0660 ENCLOSURES 0670 ATTACHED-NOTES 0680 CREATED-ID 0690 DATE-CREATED 0700 TIME-CREATED 0710 MODIFIED-ID 0720 DATE-MODIFIED 0730 TIME-MODIFIED 0740 MAILED-ID 0750 DATE-MAILED 0760 TIME-MAILED 0770 FORWARDED-ID 0780 DATE-FORWARDED 0790 TIME-FORWARDED 0800 REPLIED-ID 0810 DATE-REPLIED 0820 TIME-REPLIED 0830 EXPIRATION-DATE 0840 ARCHIVE-FLAG 0850 * 0860 IF RETURN-CODE EQ 0 0870 WRITE NOTITLE (SG=OFF ZP=OFF AD=L) 0880 'Description ' DESCRIPTION(1) (AL=40) 0890 / 24T DESCRIPTION(2) (AL=40) 0900 / 24T DESCRIPTION(3) (AL=40) 0910 / 24T DESCRIPTION(4) (AL=40) 0920 / 'Keywords ' KEYWORDS(1) 0930 / 24T KEYWORDS(2) 0940 / 24T KEYWORDS(3) 0950 / 24T KEYWORDS(4) 0960 / 24T KEYWORDS(5) 0970 / 24T KEYWORDS(6) 0980 / 'Private flag ' PRIVATE-FLAG 0990 / 'Security flags ' SECURITY-FLAGS 1000 / 'Formatting profile ' FORMATTING-PROFILE 1010 / 'Pre-format procedures ' PRE-FORMAT-PROCEDURES(1) 1020 / 24T PRE-FORMAT-PROCEDURES(2) 1030 / 24T PRE-FORMAT-PROCEDURES(3) 1040 / 24T PRE-FORMAT-PROCEDURES(4) 1050 / 'Post-format procedures' POST-FORMAT-PROCEDURES(1) 1060 / 24T POST-FORMAT-PROCEDURES(2) 1070 / 24T POST-FORMAT-PROCEDURES(3) 1080 / 24T POST-FORMAT-PROCEDURES(4) 1090 / 'Folder name ' FOLDER-NAME 1100 / 'File name ' FILE-NAME 1110 * 1120 WRITE NOTITLE (SG=OFF ZP=OFF AD=L) 1130 / 'TRS document flag ' TRS-DOCUMENT-FLAG 1140 / 'Document format ' DOCUMENT-FORMAT 1150 / 'Enclosures ' ENCLOSURES 1160 / 'Attached notes ' ATTACHED-NOTES 1170 / 'Created ID ' CREATED-ID 1180 / 'Date created ' DATE-CREATED 1190 / 'Time created ' TIME-CREATED 1200 / 'Modified ID ' MODIFIED-ID 1210 / 'Date modified ' DATE-MODIFIED 1220 / 'Time modified ' TIME-MODIFIED 1230 / 'Mailed ID ' MAILED-ID 1240 / 'Date mailed ' DATE-MAILED 1250 / 'Time mailed ' TIME-MAILED 1260 / 'Forwarded ID ' FORWARDED-ID 1270 / 'Date forwarded ' DATE-FORWARDED 1280 / 'Time forwarded ' TIME-FORWARDED 1290 / 'Replied ID ' REPLIED-ID 1300 / 'Date replied ' DATE-REPLIED 1310 / 'Time replied ' TIME-REPLIED 1320 / 'Expiration date ' EXPIRATION-DATE 1330 / 'Archive flag ' ARCHIVE-FLAG 1340 ELSE 1350 WRITE 'Return code ' RETURN-CODE 1360 END-IF 1370 * 1380 END