This document covers the following topics:
Return a list of documents, reference documents, folders/files or user-defined objects which have the specified search criteria.
The returned list contains only one kind of object (as specified in the parameter Object-number). Only the objects containing all specified keywords are returned.
This subprogram does not consider system objects (i.e. documents and reference documents which have been created by the administrator in cabinet SYSCNT).
Objects in the Wastebasket do not contain keywords.
To specify the search criteria, you can use either the parameter Keywords or the parameter Search-name. You can also use both parameters at the same time.
When you use the parameter Search-name, you enter the first letters of the desired object and an asterisk. For example, to get a list of all documents starting with "Nat", you enter "Nat*".
The following information applies to folders and files.
When you specify the parameter Search-name and do not specify a keyword, all folders beginning with the specified letters are returned. The list also contains all files in these folders, even if the file names do not start with the specified letters.
When you specify at least one keyword in addition to the parameter Search-name, the returned list contains only those folders and files that contain the specified keywords. Either the folder name or the file name must meet the search criteria. If the folder name starts with the defined letters and if a file in the folder contains the specified keywords, the file name can also start with different letters. If the file name starts with the defined letters and if the file contains the specified keywords, the name of the folder in which the file is stored can also start with different letters.
This subprogram should be invoked iteratively until the return code 77 indicates the end of the list.
| Parameter | Format | In | Out | Remarks |
|---|---|---|---|---|
| Return-code | N2 | O | X | Input -1: no ET. |
| Cabinet | A8 | R | The cabinet in which the list is to be returned. | |
| Password | A8 | R | The password of the above cabinet. | |
| Keywords | A15/1:6 | O | The keywords of the objects that you are searching for. You can specify up to 6 keywords. A keyword must not contain an asterisk (*). | |
| Object-number | N2 | R | The kind of object to be returned: 11=document, 13=folder/file, 27=reference document, 80 to 99=user-defined object. | |
| Search-name | A32 | O | The first letter(s) of the desired object and an asterisk (e.g. Nat*). | |
| Object-table (20) | ||||
| Object-name | A32 | X | The name of the object which contains the specified search criteria. The following applies to folders and files: digits 1 to 15 contain the folder name, digits 16 to 30 contain the file name (or blank, if the object is a folder). | |
| ISN | P10 | X | The ISN of the object. | |
| Description | A60 | X | The first line of the description. | |
| Date-filed | N8 | X | The date when the object was filed in this cabinet. Exception: for a folder or file, this is the date when the folder or file was created. | |
| Time-filed | N4 | X | The time when the object was filed in this cabinet. Exception: for a folder or file, this is the time when the folder or file was created. | |
| Work-parameter | A172 | For internal use. See The Work Parameter. | ||
| 00 | Success |
| 02 | Invalid cabinet name or - in batch mode only - locked cabinet |
| 03 | Password incorrect |
| 13 | Invalid object number |
| 54 | At least one keyword was invalid |
| 77 | End of list |
Z-120
Z-122
Z-123
Z-1200&0