| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Product ID | Input | Char(7) |
| 4 | Continuation access ID | Input | Char(8) |
| 5 | Error code | I/O | Char(*) |
The List SNADS File Server Object Access IDs (QZDLSTID) API can be used to list the current accesses owned by the specified product. Each access ID represents an access done on a file server object (FSO) that was obtained by using the Assign SNADS File Server Object Access ID (QZDASNID) API. The list of access IDs is returned in a user space.
This API provides a way for an application to do cleanup. For example, if the assigned access IDs that are stored are lost, you can use this API to find out what access IDs need to be revoked. An application should use this list interface at some periodic interval to check if it has any assigned access IDs that were not revoked.
If you use the MSF product ID (QMSFPRD) on the QZDASNID API, you do not have to use this API for cleanup purposes. Cleanup routines currently exist in the system to revoke access IDs assigned to the MSF product. These cleanup routines revoke access IDs only when the IDs are no longer associated with any file server object.
The continuation access ID parameter should be either set to nulls (X'00') to have this API start the search at the beginning of all access IDs, or set to a specific access ID. For the latter, the QZDLSTID API starts searching with the next greater access ID. (No error is returned if the starting access ID does not exist.) If more access IDs exist for a product than were returned on the call to the QZDLSTID API, this API sets the information status variable in the generic user space header to indicate partially complete information. To retrieve more access IDs, the caller should use the continuation access ID as input for the next call to the QZDLSTID API.
The user space that stores all the access IDs found. This structure contains the user space name and the library name where the user space is defined. The first 10 characters contain the user space name, and the second 10 characters contain the library name.
The name of the format that returns access ID information. You can specify this format:
| ACID0100 | Each entry contains an access ID. |
The identifier of the product that is using the QZDLSTID API. This parameter is necessary to group access IDs by product and to facilitate better cleanup of file server objects. For example, an installed product that was creating FSOs is removed from the system, but FSOs still exist that are referred to by that product. The SNADS cleanup routines check to ensure that the product is installed, and if the product was removed, the SNADS cleanup routines delete the remaining FSOs referred to by that product.
Valid values for this parameter are as follows:
| Product ID | The product ID of a product that is installed on the system. |
| QMSFPRD | The MSF product identifier. This value can be used for all file server objects that are referred to by the MSF messages. |
The identifier that is used together with the product ID to identify the first file server object access to find. You can determine if a previous call resulted in partially complete information by checking the information status variable in the generic user-space header following the API call.
If the API is not attempting to continue from a previous call, this parameter must be set to hexadecimal zeros. Otherwise, a valid continuation value must be supplied. The value may be obtained from the list header section of the user space used in the previous call. When continuing, the first entry in the returned list is the entry that immediately follows the last entry returned in the previous call.
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following tables describe the order and format of the data returned in the user space.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name specified |
| 10 | A | CHAR(10) | User space library name specified |
| 20 | 14 | CHAR(8) | Format name |
| 28 | 1C | CHAR(7) | Product ID |
| 35 | 23 | CHAR(8) | Continuation access ID |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(8) | Continuation access ID |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(8) | Access ID |
Access ID. Each entry in the returned list contains an access ID that is currently assigned to the product specified on input.
Continuation access ID (header section). A continuation point for the API. This value is set based on the contents of the information status variable in the generic header for the user space. The following situations can occur for the following information statuses:
| C | The information returned in the user space is valid and complete. No continuation is necessary and the continuation access ID is set to nulls (X'00'). |
| P | The information returned in the user space is valid but incomplete. The user may call the API again, starting where the last call left off. The continuation access ID contains a value, which may be supplied as an input parameter in later calls. |
| I | The information returned in the user space is not valid and not complete. The content of the continuation access ID is unpredictable. |
Continuation access ID (input section). The identifier that is used to continue from a previous call to this API, which resulted in partially complete information.
Format name. The name of the format used to return access ID information.
Product ID. The identifier of the product that is using the QZDLSTID API.
User space library name specified. The name of the library that contains the user space.
User space name specified. The name of the user space to which the list of access IDs is returned.
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3A09 E | System error. |
| CPF3A12 E | Interface error. |
| CPF3A13 E | Access ID not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
[ Back to top | Office APIs | APIs by category ]