Kernel Domain Xpi Functions; The Start_Purge_Protection Function; The Stop_Purge_Protection Function - IBM SC34-6814-04 Customization Manual

The ENQUEUE_TOKEN, ENQUEUE_NAME1, ENQUEUE_NAME2, and
MAX_LIFETIME(DISPATCHER_TASK) parameters are the same as in the
ENQUEUE function call.
RESPONSE and REASON values for DEQUEUE
RESPONSE
OK
EXCEPTION

Kernel domain XPI functions

The START_PURGE_PROTECTION function

The START_PURGE_PROTECTION function is provided on the DFHKEDSX macro
call. It inhibits purge, but not force-purge, for the current task. This function can be
used by all global user exit programs if they want to inhibit purge during a global
user exit call.
In general, each START_PURGE_PROTECTION call should have a corresponding
STOP_PURGE_PROTECTION function call to end the purge protection period on
completion of any program logic that needs such protection.
START_PURGE_PROTECTION
DFHKEDSX [CALL,]
This command is threadsafe.
There are no input or output parameters on this call, only a RESPONSE.
RESPONSE values for START_PURGE_PROTECTION:
RESPONSE
OK
DISASTER
INVALID

The STOP_PURGE_PROTECTION function

The STOP_PURGE_PROTECTION function is provided on the DFHKEDSX macro
call. It is re-enables purge for the current task after purge has been suspended by a
preceding START_PURGE_PROTECTION function call.
[CLEAR,]
[IN,
FUNCTION(START_PURGE_PROTECTION),]
[OUT,
RESPONSE (name1 | *)]
REASON
None
ENQUEUE_NOT_OWNED
ENQUEUE_LOCKED
REASON
None
None
None
Chapter 3. The user exit programming interface (XPI)
351