XPI functions (by domain)
The XPI functions are grouped according to their functional relationships. Grouping is generally based on the CICS® domain in which the XPI functions occur.
To understand the syntax that is used to describe the XPI
functions, see XPI syntax.
- Business application manager domain XPI function
The XPI provides one business application manager domain function. This is the DFHBABRX call INQUIRE_ACTIVATION. - Directory domain XPI functions
The XPI provides directory domain functions that you can use to open and close an LDAP session, browse results for credentials, scan and locate results, close the browse, return the correct value and close the search. - Dispatcher XPI functions
The XPI provides six dispatcher functions. These functions are the DFHDSSRX calls ADD_SUSPEND, SUSPEND, RESUME, DELETE_SUSPEND, and WAIT_MVS, and the DFHDSATX call CHANGE_PRIORITY. - Dump control XPI functions
The XPI provides two dump control functions. These are the DFHDUDUX macro calls SYSTEM_DUMP and TRANSACTION_DUMP. - Enqueue domain XPI functions
The XPI provides two enqueue domain functions. These are the DFHNQEDX calls DEQUEUE and ENQUEUE. - Kernel domain XPI functions
The XPI provides two kernel domain functions. These are the DFHKEDSX calls START_PURGE_PROTECTION and STOP_PURGE_PROTECTION. - Loader XPI functions
The XPI provides five loader functions. These functions are the DFHLDLDX calls ACQUIRE_PROGRAM, DEFINE_PROGRAM, DELETE_PROGRAM, IDENTIFY_PROGRAM, and RELEASE_PROGRAM. - Log manager XPI functions
The XPI provides two log manager functions. These are the DFHLGPAX calls INQUIRE_PARAMETERS and SET_PARAMETERS. You can use these calls to inquire upon, and set, the log manager parameter, KEYPOINT_FREQUENCY. This parameter specifies the activity keypoint frequency of the CICS region. - Monitoring XPI functions
The XPI provides four monitoring functions: the DFHMNMNX calls INQUIRE_MONITORING_DATA and MONITOR, the DFHMNTDX call SET_TRACKING_DATA, and the DFHMNIAX call INQUIRE_APP_CONTEXT. - Object transaction XPI functions
You can use the object transaction XPI calls to implement a TRUE program that responds to calls between a CICS unit of work and a remote transaction coordinator. These are the DFHOTTRX calls COMMIT, COMMIT_ONE_PHASE, IMPORT_TRAN, PREPARE, ROLLBACK, and SET_ROLLBACK_ONLY, and the DFHOTCOX call SET_COORDINATOR. These functions provide powerful control over the sync point processing of a CICS unit of work. If you use these calls incorrectly, the CICS Recovery Manager terminates CICS immediately and recovery and resynchronization processing is required. - Program management XPI functions
The XPI provides eight program management functions, including DFHPGISX, DFHPGAQX, and DFHPGCHX calls. Together with the loader functions, these functions provide a comprehensive set of tools to manipulate programs. - State data access XPI functions
The XPI provides state data access functions that you can use to inquire on, and set, certain system data in the AP domain. These are the DFHAPIQX calls INQ_APPLICATION_DATA, INQUIRE_SYSTEM, and SET_SYSTEM. - Storage control XPI functions
The XPI provides seven storage control functions. These are the DFHSMMCX macro calls GETMAIN, FREEMAIN, INQUIRE_ELEMENT_LENGTH, and INQUIRE_TASK_STORAGE, and the DFHSMSRX calls INQUIRE_ACCESS, INQUIRE_SHORT_ON_STORAGE, and SWITCH_SUBSPACE. - Trace control XPI function
The XPI provides one trace control function. This is the DFHTRPTX call TRACE_PUT. - Transaction management XPI functions
The XPI provides transaction management functions that you can use to inquire about transactions and set certain transaction parameters. - User journaling XPI function
The XPI provides one user journaling function, which is the DFHJCJCX call WRITE_JOURNAL_DATA. - Threadsafe XPI commands
Most, but not all, XPI commands are threadsafe. Issuing any of the non-threadsafe commands causes CICS to use the QR TCB to ensure serialization.
dfha3_xpi_functions.html |
Last updated: Monday, 5 June 2017