Z-GET11C

This document covers the following topics:

Description

Return a document, including cover notes and enclosed documents, into a text array.

The parameters Text-array, Last-line-filled and Last-line-text are returned only for the document formats Txt and Cnf. All other document formats (such as Bin) are returned only once in the Document-format parameter. For example, for a binary enclosure consisting of several records, only the first record is read; the parameters Document-format, Text-type, Text-type-total, Text-type-current are filled; the Text-array parameter remains empty, therefore, 0 is returned in the parameters Last-line-filled and Last-line-text.

This subprogram should be invoked iteratively until the return code is 77. Return code 77 indicates that the document including all cover notes and enclosures has been read.

Notes:

  1. To return an item that is stored in the folder Inbasket, Outbasket or Wastebasket, you must pass the ISN which has been returned from a previous API subprogram.
  2. If a document does not have a name (i.e. if the document is identified by its description), it can only be returned using the ISN.

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 that you want to return. Either Document-name or ISN, not both.
ISN P8 R*   The ISN of the document that you want to return. Either ISN or Document-name, not both.
Description A60/1:4   X The description of the document.
Document-format A1   X See Document Formats.
Text-type A1   X The type of text which is currently being processed: C=cover note, T=document text, E=enclosed document.
Text-type-total P3   X The total number of cover notes or enclosures. The numbers of cover notes and enclosures are returned separately. For the document itself, 0 is returned.
Text-type-current P3   X The sequence number of the cover note/enclosure currently being processed. The numbers of cover notes and enclosures are returned separately. For the document itself, 0 is returned.
Text-array A251/1:20   X Only returned for the document formats 0 (Txt) and 1( Cnf). The first character returned in every element of the Text-array indicates the number of lines to repeat.
Last-line-filled N2   X The number of all lines of the current record, including all blank lines at the end of the text. Only returned for the document formats 0 (Txt) and 1 (Cnf).
Last-line-text N2   X The number of the last text line, not considering blank lines at the end of the text. Only returned for the document formats 0 (Txt) and 1 (Cnf).
Work-parameter-1 A240     For internal use. See The Work Parameter.
Work-parameter-2 A79     For internal use. See The Work Parameter.

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
77 End of object

Subprograms

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