Description

A DELETE request allows you to delete a single list entry from the list structure. Once removed from the list, the storage resources associated with the entry can be reused.

You can also specify that the designated entry be deleted only if it contains data that satisfies a version number comparison.

The entry you designate must exist on the list you specify, or the request fails with no change to the structure.

With a coupling facility of CFLEVEL=1 or higher, the following additional functions are supported for a DELETE request:

You can specify that a list entry is to be deleted only after a successful comparison of the list authority value for the target list with a user specified value. You specify the list authority comparison requirements using AUTHCOMP and AUTHCOMPTYPE. If the request is successful, you also can update the list authority value to a new value that you specify with NEWAUTH.
Version number comparison is enhanced to allow for an additional equal-or-less-than-equal comparison operation.
There are additional list cursor options. You can update the list cursor conditionally, and you can set the list cursor to point to the current entry instead of the previous or next entry.

On the DELETE request, you can optionally read data from the entry by specifying DATAOPER=READ. Before it deletes the entry, the system reads any combination of the following types of data for the designated entry:

List entry controls
Entry data
Adjunct data

Whether a particular data type is returned also depends on whether the local storage area to contain that data is specified. Listed below is the data that is returned and the storage area that should be specified to contain that returned data:

List entry controls, the number of list entries or elements remaining on the list, and the total number of allocated entries in the structure are returned to the answer area (ANSAREA).
Entry data is returned to the buffer (BUFFER) or buffer list (BUFLIST). (DATAOPER=READ must be specified.)
Adjunct data is returned to the adjunct area (ADJAREA). (DATAOPER=READ must be specified.)

Additionally, you can perform locking functions with a DELETE request by specifying LOCKINDEX. The lock entry designated by LOCKINDEX will be operated on as specified by LOCKOPER.