| 1 | Product ID | Input | Char(7) |
| 2 | Access ID | Input | Char(8) |
| 3 | File server object handle | Output | Char(32) |
| 4 | Correlation | Output | Char(3000) |
| 5 | Correlation bytes available | Output | Binary(4) |
| 6 | Error code | I/O | Char(*) |
The Retrieve SNADS File Server Object Access ID (QZDRTVID) API allows the caller to retrieve information about one access ID. This information includes the file server object handle for the access ID and any correlation information associated with the access ID.
The identifier of the product that is using the List SNADS File Server Object Access IDs (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:
The product ID of a product that is installed on the system.
| QMSFPRD | 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 file server object access to find. Valid values for this parameter are as follows:
'0000000000000000'X through 'FFFFFFFFFFFFFFFF'X
The necessary linkage to the file server object that was found by this API is contained in this parameter.
The correlation is further identification of a file server object access that was found by this API. The correlation information is defined by the caller.
The number of bytes of correlation data returned. Valid values for this parameter are:
0 through 3000
The structure in which to return error information. For the format of the structure, see Error code parameter.
| 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 ]