purge()

The sysLib.purge() system function deletes a CICS® temporary storage queue.

If you call sysLib.purge(), the program runs the CICS ENQ command with the NOSUSPEND option to enqueue on the resource name EZETEMP-queuename. The program runs the CICS DEQ command to dequeue after the temporary storage queue is deleted.

Syntax

  sysLib.purge(queueName CHAR(8) in)
queueName
Either a literal or a variable of type CHAR (1 to 8 bytes). queueName is required and contains the name of a single temporary storage queue.

Example

The following code deletes the CICS temporary storage queue associated with the current value of resourceAssociation for record myCustomer:

  myQueue CHAR(8);
  myQueue = myCustomer.resourceAssociation;
  sysLib.purge(myQueue);

Error considerations

If an error occurs and you have set the v60ExceptionCompatibility program property to YES, the first byte of the EIBFN is placed in the first 2 characters of sysVar.errorCode, and bytes 0 to 2 of the EIBRCODE are placed in the last 6 characters of sysVar.errorCode.

Compatibility

Table 1. Compatibility considerations for purge()
Platform Issue
Java™ generation The sysLib.purge() function is not supported.
JavaScript generation The sysLib.purge() function is not supported.

Feedback