Revoke SNADS File Server Object Access ID (QZDRVKID) API
Required Parameter Group:
| 1 | Product ID | Input | Char(7) |
| 2 | Access ID | Input | Char(8) |
| 3 | Error code | I/O | Char(*) |
Default Public Authority: *EXCLUDE
Threadsafe: No
The Revoke SNADS File Server Object Access ID (QZDRVKID) API revokes an access ID to a specific file server object (FSO) that was previously assigned. Revoking an access lets the system know that the current process has finished working with the file server object. The access ID that was originally assigned to the file server object must be passed as input. This API also decrements the usage count of the file server object by one.
Authorities and Locks
- API Public Authority
- *EXCLUDE
Required Parameter Group
- Product ID
- INPUT; CHAR(7)
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. - Access ID
- INPUT; CHAR(8)
The identifier that is used along with the product ID to identify the file server object access. The value of this parameter should be taken from the access ID that was returned on the call to the Assign SNADS File Server Object Access ID (QZDASNID) API.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
| 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. |
API Introduced: V3R6
[ Back to top | Office APIs | APIs by category ]