This document covers the following topics:
Return the text lines of a user-defined object into a text array.
This subprogram can be invoked iteratively, until the return code 77 indicates the end of the object.
When you return the text lines of a user-defined object which is currently stored in the Inbasket file New, the corresponding address list is updated so that the reception status of the user-defined object indicates that it has been read. Additionally, the user-defined object is moved from the file New to the file Opened. In this case, END TRANSACTION is automatically issued.
| Parameter | Format | In | Out | Remarks |
|---|---|---|---|---|
| Return-code | N2 | O | X | Input -1: no ET. |
| Cabinet | A8 | R | The cabinet in which the user-defined object is stored. | |
| Password | A8 | R | The password of the above cabinet. | |
| Object-number | N2 | R | The number of the user-defined object to be returned. | |
| Object-name | A32 | R* | The name of the user-defined object. Either Object-name or Object-ISN, not both. | |
| Object-ISN | P8 | R* | X | The ISN of the user-defined object. Input: either Object-ISN or Object-name, not both. |
| Object-format | A1 | X | Can be any user-defined object format. If the object is a document, this can also be a Con-nect document format. See Document Formats. | |
| Folder-name | A15 | X | The folder in which the user-defined object is stored. | |
| File-name | A15 | X | The file within the above folder in which the user-defined object is stored. | |
| Description | A60/1:4 | X | The description of the user-defined object. | |
| User-data | A60/1:4 | X | Can be any information included by the user. | |
| Text-array | A251/1:20 | X | Can be any text included by the user. | |
| Work-parameter | A21 | For internal use. See The Work Parameter. |
| 00 | Success |
| 02 | Invalid cabinet name |
| 03 | Password incorrect |
| 04 | Object ISN was not found |
| 08 | Supply either object ISN or name, not both |
| 09 | ISN does not point to an object record |
| 51 | Invalid name |
| 53 | Requested object does not exist |
| 68 | Object is not a user-defined object |
| 77 | End of list |
Z-120
Z-122
Z-123
Z-147
Z-165
Z-175
Z-177
Z-194
Z-197
Z-222
Z-223
Z-400
Z-401
Z-1200&0