Temporary storage domain exits XTSQRIN, XTSQROUT, XTSPTIN, and XTSPTOUT

The temporary storage domain exits XTSQRIN, XTSQROUT, XTSPTIN, and XTSPTOUT allow you to:

The temporary storage domain has two main gates, TSQR, and TSPT, which support the following functions:

TSQR
Write, Rewrite, Read_into, Read_set, Read_next_into, Read_next_set, Delete.
TSPT
Put, Put_replace, Get, Get_set, Get_release, Get_release_set, Release.

The TSQR functions correspond to those available through the EXEC CICS interface (or through DFHTS TYPE=PUTQ, GETQ, or PURGE). The TSPT functions are used by the interval control program in support of START and RETRIEVE functions (or DFHTS TYPE=PUT, GET, or RELEASE).

Exit XTSQRIN

When invoked
Before execution of a user temporary storage interface request for a user TS queue (for example, a WRITEQ TS, or READQ TS request).
Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Address of the 4-byte terminal ID.
UEPPROG
Address of the 8-byte application program name.
UEP_TS_FUNCTION
Address of a byte containing the function:
  • UEP_TS_FUN_WRITE
  • UEP_TS_FUN_REWRITE
  • UEP_TS_FUN_READ_INTO
  • UEP_TS_FUN_READ_SET
  • UEP_TS_FUN_READ_NEXT_INTO
  • UEP_TS_FUN_READ_NEXT_SET
  • UEP_TS_FUN_DELETE
UEP_TS_QUEUE_NAME
Address of a 16-byte field containing the queue name.
UEP_TS_DATA_P
Address of a fullword containing the address of the data. (Write and rewrite requests).
UEP_TS_DATA_L
Address of a fullword containing the length of the data. (Write and rewrite requests).
UEP_TS_ITEM_NUMBER
Address of a fullword containing the item number. (Rewrite, read_into and read_set requests).
UEP_TS_STORAGE_TYPE
Address of a byte containing the storage type. (Write requests).

On input to the exit, the parameter will be set to either UEP_TS_STORAGE_TYPE_MAIN or UEP_TS_STORAGE_TYPE_AUX_TST. This parameter may be modified by the exit to any of the values below.

Note that if CICS® has been initialized with TS main-only support, setting this parameter has no effect.

UEP_TS_STORAGE_TYPE_MAIN
Main storage.
UEP_TS_STORAGE_TYPE_AUX_TST
Auxiliary storage (recoverability determined by the TST).
UEP_TS_STORAGE_TYPE_AUX_RECOV_YES
Auxiliary storage (recoverable).
UEP_TS_STORAGE_TYPE_AUX_RECOV_NO
Auxiliary storage (non-recoverable).
Return codes
UERCNORM
Normal.
UERCPURG
Purged.
XPI calls
All can be used.
API and SPI calls
None can be used.

Exit XTSQROUT

When invoked
After execution of a user temporary storage interface request for a user TS queue (for example, a WRITEQ TS, or READQ TS request).
Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Address of the 4-byte terminal ID.
UEPPROG
Address of the 8-byte application program name.
UEP_TS_FUNCTION
Address of a byte containing the function:
  • UEP_TS_FUN_WRITE
  • UEP_TS_FUN_REWRITE
  • UEP_TS_FUN_READ_INTO
  • UEP_TS_FUN_READ_SET
  • UEP_TS_FUN_READ_NEXT_INTO
  • UEP_TS_FUN_READ_NEXT_SET
  • UEP_TS_FUN_DELETE
UEP_TS_QUEUE_NAME
Address of a 16-byte field containing the queue name.
UEP_TS_DATA_P
Address of a fullword containing the address of the data. (All requests except delete).
UEP_TS_DATA_L
Address of a fullword containing the length of the data. (All requests except delete).
UEP_TS_ITEM_NUMBER
Address of a fullword containing the item number. (Rewrite, read_into and read_set requests).
UEP_TS_TOTAL_ITEMS
Address of a fullword containing the total number of items in the queue. (All requests except delete).
UEP_TS_RESPONSE
Address of a byte containing the response after a request has been completed.
  • UEP_TS_RESPONSE_OK
  • UEP_TS_RESPONSE_PURGED
  • UEP_TS_RESPONSE_EXCEPTION
  • UEP_TS_RESPONSE_DISASTER
  • UEP_TS_RESPONSE_INVALID
Return codes
UERCNORM
Normal response.
UERCPURG
A purged response was received from an XPI request.
XPI calls
All can be used.
API and SPI calls
None can be used.

Exit XTSPTIN

When invoked
Before execution of a temporary storage interface request for a CICS internal queue (for example, for interval control or BMS queues).
Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Address of the 4-byte terminal ID.
UEPPROG
Address of the 8-byte application program name.
UEP_TS_FUNCTION
Address of a byte containing the function:
  • UEP_TS_FUN_PUT
  • UEP_TS_FUN_PUT_REPLACE
  • UEP_TS_FUN_GET
  • UEP_TS_FUN_GET_SET
  • UEP_TS_FUN_GET_RELEASE
  • UEP_TS_FUN_GET_RELEASE_SET
  • UEP_TS_FUN_RELEASE
UEP_TS_QUEUE_NAME
Address of a 16-byte field containing the queue name.
UEP_TS_DATA_P
Address of a fullword containing the address of the data. (Put and put_replace).
UEP_TS_DATA_L
Address of a fullword containing the length of the data. (Put and put_replace).
UEP_TS_STORAGE_TYPE
Address of a byte containing the storage type. (Put requests).

On input to the exit, the parameter will be set to either UEP_TS_STORAGE_TYPE_MAIN or UEP_TS_STORAGE_TYPE_AUX_TST. This parameter may be modified by the exit to any of the values below.

Note that if CICS has been initialized with TS main-only support, setting this parameter has no effect.

UEP_TS_STORAGE_TYPE_MAIN
Main storage.
UEP_TS_STORAGE_TYPE_AUX_TST
Auxiliary storage (recoverability determined by the TST).
UEP_TS_STORAGE_TYPE_AUX_RECOV_YES
Auxiliary storage (recoverable).
UEP_TS_STORAGE_TYPE_AUX_RECOV_NO
Auxiliary storage (non-recoverable).
Return codes
UERCNORM
Normal.
UERCPURG
Task purged during XPI call.
XPI calls
All can be used.
API and SPI calls
None can be used.

Exit XTSPTOUT

When invoked
After execution of a temporary storage interface request for a CICS internal queue (for example, for interval control or BMS queues). After execution of a TSPT request. No parameters may be modified.
Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Address of the 4-byte terminal ID.
UEPPROG
Address of the 8-byte application program name.
UEP_TS_FUNCTION
Address of a byte containing the function:
  • UEP_TS_FUNCTION_PUT
  • UEP_TS_FUN_PUT_REPLACE
  • UEP_TS_FUN_GET
  • UEP_TS_FUN_GET_SET
  • UEP_TS_FUN_GET_RELEASE
  • UEP_TS_FUN_GET_RELEASE_SET
  • UEP_TS_FUN_RELEASE
UEP_TS_QUEUE_NAME
Address of a 16-byte field containing the queue name.
UEP_TS_DATA_P
Address of a fullword containing the address of the data. (All requests except release).
UEP_TS_DATA_L
Address of a fullword containing the length of the data. (All requests except release).
UEP_TS_RESPONSE
Address of a byte containing the response after a request has been completed.
  • UEP_TS_RESPONSE_OK
  • UEP_TS_RESPONSE_PURGED
  • UEP_TS_RESPONSE_EXCEPTION
  • UEP_TS_RESPONSE_DISASTER
  • UEP_TS_RESPONSE_INVALID
Return codes
UERCNORM
Normal response.
UERCPURG
A purged response was received from an XPI request.
XPI calls
All can be used.
API and SPI calls
None can be used.

Related concepts
Overview -- what is a global user exit?
Overview of the XPI
Global user exit XPI examples, showing the use of storage
Related tasks
Writing global user exit programs
Making an XPI call
Related reference
List of global user exit points
The XPI functions
[[ Contents Previous Page | Next Page Index ]]