purge()

The system function SysLib.purge deletes a CICS® temporary storage queue.

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

If you use SysLib.purge as the function name in a function invocation statement, 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. If an error occurs, 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.

Example

The following deletes the CICS temporary storage queue associated with the current value of resourceAssociation for record ABC (where myqueue is an item name):

  myqueue = abc.resourceAssociation;
  SysLib.purge(myqueue);

The following deletes the CICS temporary storage queue associated with destination XYZ:

  SysLib.purge("XYZ");

Related reference

EGL library SysLib

Feedback
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.