Z-GET11X

This document covers the following topics:


Description

Return the description of a document.

This subprogram is the same as Z-GET11 with the one exception that the parameter ISN uses the format P10.

If the document contains text, the text is copied to the Natural source code edit area (ESIZE). Using Z-ADD11X, for example, you can add a Con-nect document from the contents of this edit area.

Parameters

Parameter Format In Out Remarks
Return-code N2 O X Input -1: no ET.
Cabinet A8 R   The cabinet which contains the wanted document.
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 description. Either Document-name or ISN, not both.
ISN P10 R*   The ISN of the document for which you want to return the description. 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.

Return Codes

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
57 Document contains no text
91 Document is not in Txt or Cnf format

Subprograms

Z-115
Z-120
Z-122
Z-123
Z-130
Z-140
Z-165
Z-175
Z-194
Z-197
Z-222
Z-223
Z-400
Z-401
Z-1200&0

Example

0010 *
0020 * Example program to return the description of a document.
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 #INDEX             (I1)
0130 *
0140 END-DEFINE
0150 *
0160 RESET RETURN-CODE
0170 MOVE 'CABINET'  TO CABINET
0180 MOVE 'PASSWORD' TO PASSWORD
0190 MOVE 1234567890 TO ISN
0200 *
0200 *
0210 CALLNAT 'Z-GET11X'
0220   RETURN-CODE
0230   CABINET
0240   PASSWORD
0250   DOCUMENT-NAME
0260   ISN
0270   DESCRIPTION(*)
0280 *
0290 IF  RETURN-CODE EQ 0
0300   WRITE 'Return status OK' (I) /
0310   FOR #INDEX 1 TO 4
0320     WRITE '=' DESCRIPTION(#INDEX)
0330   END-FOR
0340 ELSE
0350   WRITE 'Return code ' RETURN-CODE
0360 END-IF
0370 *
0380 END