PGIS gate, INQUIRE_CURRENT_PROGRAM function
The INQUIRE_CURRENT_PROGRAM function of the PGIS gate is used to inquire about the current attributes of a program (for the current invocation of the program).
Input Parameters
- PROGRAM_TOKEN
- Optional parameter
- A token that identifies the program to inquire about.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- LOCK_ERROR
- The following values are returned when RESPONSE is EXCEPTION:
- NO_CURRENT_PROGRAM
- The values for the parameter are as follows:
- NO_REASON
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- AVAIL_STATUS
- Optional parameter
- Indicates whether the program can be used (ENABLED) or not (DISABLED).
- Values for the parameter are as follows:
- DISABLED
- ENABLED
- CEDF_STATUS
- Optional parameter
- Indicates whether the EDF diagnostic screens are displayed when the program is running under the control of the execution diagnostic facility (EDF)
- Values for the parameter are as follows:
- CEDF
- NOCEDF
- NOT_APPLIC
- CONCURRENCY
- Optional Parameter
- Indicates whether the program is threadsafe or only quasi-reentrant.
- Values for the parameter are as follows:
- QUASIRENT
- REQUIRED
- THREADSAFE
- CURRENT_AMODE
- Optional parameter
- The current addressing mode of the program.
- Values for the parameter are as follows:
- 24
- 31
- 64
- CURRENT_CEDF_STATUS
- Optional parameter
- Indicates whether the EDF diagnostic screens are displayed when the program is running under the control of the execution diagnostic facility (EDF).
- Values for the parameter are as follows:
- CEDF
- NOCEDF
- CURRENT_ENTRY_POINT
- Optional parameter
- The current entry point address of the program, as returned by the loader domain on the ACQUIRE_PROGRAM call.
- CURRENT_ENVIRONMENT
- Optional parameter
- Indicates the current environment in which the program is running.
- Values for the parameter are as follows:
- EXEC
- GLUE
- PLT
- SYSTEM
- TRUE
- URM
- CURRENT_EXECUTION_SET
- Optional parameter
- Indicates whether the program is running with or without the API restrictions of a DPL program.
- Values for the parameter are as follows:
- DPLSUBSET
- FULLAPI
- CURRENT_LOAD_POINT
- Optional parameter
- The current load point address of the program, as returned by the loader domain on the ACQUIRE_PROGRAM call.
- CURRENT_PROGRAM_LENGTH
- Optional parameter
- The length of the current program in bytes, as returned by the loader domain on the AQUIRE_PROGRAM call.
- CURRENT_PROGRAM_NAME
- Optional parameter
- The current name of the program.
- DATA_LOCATION
- Optional parameter
- Indicates whether the program can handle only 24-bit addresses (data located below the 16 MB line), or can also handle 31-bit addresses (data located above or below the 16 MB line). The DATALOCATION options are independent from the addressing mode of the link-edited program.
- Values for the parameter are as follows:
- ANY
- BELOW
- NOT_APPLIC
- DYNAMIC_STATUS
- Optional parameter
- Indicates whether a request to LINK to the program can be dynamically routed.
- Values for the parameter are as follows:
- DYNAMIC
- NOTDYNAMIC
- EXECUTION_KEY
- Optional parameter
- The key in which CICS® gives control to the program, and that determines whether the program can modify CICS-key storage. If the program is link-edited with the RENT attribute and the RMODE(ANY) mode statement, CICS loads the program into the extended read-only DSA (ERDSA), regardless of the EXECKEY option. The ERDSA is allocated from read-only extended storage only if RENTPGM=PROTECT is specified as a system initialization parameter.
- Values for the parameter are as follows:
- CICS
- NOT_APPLIC
- USER
- EXECUTION_SET
- Optional parameter
- Indicates whether CICS can link to and run the program as if it were running in a remote CICS region (with or without the API restrictions of a DPL program).
- Values for the parameter are as follows:
- DPLSUBSET
- FULLAPI
- NOT_APPLIC
- HOLD_STATUS
- Optional parameter
- The hold status of the program (that is, for how long the program is to be loaded).
- Values for the parameter are as follows:
- CICS_LIFE
- NOT_APPLIC
- TASK_LIFE
- IGNORE_EXITS
- Optional parameter
- Indicates whether global user exit programs and task-related user exit programs are ignored when returning information about the program that invoked this program and to which control will be returned.
- Values for the parameter are as follows:
- YES
- NO
- INSTALL_TYPE
- Optional parameter
- The method used to install the PROGRAM resource definition.
- Values for the parameter are as follows:
- AUTO
- CATALOG
- GROUPLIST
- MANUAL
- RDO
- SYSAUTO
- INVOKING_ENVIRONMENT
- Optional parameter
- The environment in which the program that invoked this program was running.
- Values for the parameter are as follows:
- EXEC
- GLUE
- PLT
- SYSTEM
- TRUE
- URM
- INVOKING_PROGRAM_NAME
- Optional parameter
- The name of the program that invoked this program.
- LANGUAGE_DEDUCED
- Optional parameter
- The language deduced by CICS for the program.
- Values for the parameter are as follows:
- ASSEMBLER
- COBOL
- COBOL2
- C370
- JAVA
- LE370
- NOT_APPLIC
- NOT_DEDUCED
- PLI
- LANGUAGE_DEFINED
- Optional parameter
- The language defined for the program.
- Values for the parameter are as follows:
- ASSEMBLER
- COBOL
- C370
- LE370
- NOT_APPLIC
- NOT_DEFINED
- PLI
- LIBRARY
- Optional parameter
- The name of the LIBRARY concatenation from which the program was loaded.
- LIBRARYDSN
- Optional parameter
- The name of the data set in the LIBRARY concatenation from which the program was loaded.
- LOAD_STATUS
- Optional parameter
- The load status of the program (that is, whether the program can be loaded).
- Values for the parameter are as follows:
- LOADABLE
- NOT_APPLIC
- NOT_LOADABLE
- NOT_LOADED
- MODULE_TYPE
- Optional parameter
- The type of program resource.
- Values for the parameter are as follows:
- MAPSET
- PARTITIONSET
- PROGRAM
- NEW_PROGRAM_TOKEN
- Optional parameter
- The token assigned to the program.
- REMOTE_DEFINITION
- Optional parameter
- Indicates whether the program is defined as remote or local.
- Values for the parameter are as follows:
- LOCAL
- REMOTE
- REMOTE_PROGID
- Optional parameter
- The name by which the program is known in the remote CICS region. If you specify REMOTE_SYSID and omit REMOTE_PROGID, the REMOTE_PROGID parameter defaults to the same name as the local name (that is, the PROGRAM_NAME value).
- REMOTE_SYSID
- Optional parameter
- The name of a remote CICS region if CICS can ship a distributed program link (DPL) request to another CICS region.
- REMOTE_TRANID
- Optional parameter
- The name of the transaction the remote CICS can attach to, and under which it can run the remote program.
- RETURN_PROGRAM_NAME
- Optional parameter
- The name of the program to which control will be returned when this program ends.