PGIS gate, INQUIRE_PROGRAM function
The INQUIRE_PROGRAM function of the PGIS gate is used to inquire about attributes of a program.
Input Parameters
- AC_APPL_CONTEXT_TOKEN
- Optional parameter
- A token that defines the application context for a PROGRAM. An alternative to specifying AC_PLATFORM_NAME, AC_APPLICATION_NAME, AC_MAJOR_VERSION, AC_MINOR_VERSION, and AC_MICRO_VERSION.
- AC_APPLICATION_NAME
- Optional parameter
- The 64-character name of the application associated with the program being inquired upon.
- AC_MAJOR_VERSION
- Optional parameter
- The fullword binary value that is the major version of the application associated with the program being inquired upon.
- AC_MINOR_VERSION
- Optional parameter
- The fullword binary value that is the minor version of the application associated with the program being inquired upon.
- AC_MICRO_VERSION
- Optional parameter
- The fullword binary value that is the micro version of the application associated with the program being inquired upon.
- AC_PLATFORM_NAME
- Optional parameter
- The 64-character name of the platform associated with the program being inquired upon.
- APPLICATION_NAME
- Optional parameter
- The 64-character buffer to receive the name of the application associated with the program.
- OPERATION_NAME
- Optional parameter
- The 64-character buffer to receive the name of the operation associated with the program.
- PLATFORM_NAME
- Optional parameter
- The 64-character buffer to receive the name of the platform associated with the program.
- PROGRAM_NAME
- The name of the program resource to inquire about.
- PROGRAM_TOKEN
- The token that identifies the program to inquire about.
- RESOURCE_SIGNATURE
- Optional parameter
- A buffer to receive the PROGRAM resource signature.
- SHOW_PROGRAMS
- This field is required if an application context is supplied using the fields beginning AC_. It specifies whether private programs only, or first private and then public programs, are searched.
- Values for the parameter are as follows:
- PRIVATE
- PRIVATE_AND_PUBLIC
- If this field is specified but no application context is supplied, an inquiry with PRIVATE_AND_PUBLIC searches only public programs, and an inquiry with PRIVATE returns a not found response.
- JVM_CLASS
- Optional Parameter
- The name of the main class in a Java™ program to be run under the control of a Java Virtual Machine (JVM).
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- LOCK_ERROR
- The following values are returned when RESPONSE is EXCEPTION:
- PROGRAM_NOT_DEFINED_TO_LD
- PROGRAM_NOT_DEFINED_TO_PG
- APP_CONTEXT_NOT_FOUND
- The following values are returned when RESPONSE is INVALID:
- INVALID_PROGRAM_TOKEN
- 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.
- ACCESS
- Optional Parameter
- The type of access for the program.
- Values for the parameter are as follows:
- CICS
- NONE
- READ_ONLY
- USER
- APIST
- Optional Parameter
- Indicates whether the program is restricted to use only of the CICS® permitted application programming interfaces.
- Values for the parameter are as follows:
- CICSAPI
- OPENAPI
- 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
- DATA_LOCATION
- Optional Parameter
- Defines 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
- ENTRY_POINT
- Optional Parameter
- The token that defines the entry point of the program.
- ENTRYPOINT_BUN_TOKEN
- Optional parameter
- An 8-byte token that represents the bundle that defined the application entry point.
- ENTRYPOINT_RES_TOKEN
- Optional parameter
- An 8-byte token that represents the application entry point.
- 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
- 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
- JVM
- Optional Parameter
- Indicates whether the program can run under the control of a JVM (Java Virtual Machine).
- Values for the parameter are as follows:
- NO
- YES
- JVM_PROFILE
- Optional Parameter
- Specifies the name of the JVM profile. The named profile provides the attributes of the JVM that are needed to run the program.
- JVMPROGRAM_USE_COUNT
- Optional Parameter
- For Java programs that run under the control of a JVM, the number of times the program has been used.
- 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
- LANGUAGE_TOKEN
- Optional Parameter
- A token that represents the AP domain language block for the program.
- 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_POINT
- Optional Parameter
- The load point address of the program, as returned by the loader domain on the ACQUIRE_PROGRAM call.
- 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
- LOADER_TOKEN
- Optional Parameter
- The token that the loader domain uses to identify the program.
- LOCATION
- Optional Parameter
- Indicates where the program resides.
- Values for the parameter are as follows:
- CDSA
- ECDSA
- ELPA
- ERDSA
- ESDSA
- LPA
- NONE
- RDSA
- SDSA
- MAJOR_VERSION
- Optional parameter
- The fullword binary value that is the major version of the application associated with the program.
- MINOR_VERSION
- Optional parameter
- The fullword binary value that is the minor version of the application associated with the program.
- MICRO_VERSION
- Optional parameter
- The fullword binary value that is the micro version of the application associated with the program.
- 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.
- PROGRAM_ATTRIBUTE
- Optional Parameter
- The residence status of the program, and when the storage for this program is released.
- Values for the parameter are as follows:
- RELOAD
- RESIDENT
- REUSABLE
- TEST
- TRANSIENT
- PROGRAM_LENGTH
- Optional Parameter
- The length of the program, as returned by the loader domain on the ACQUIRE_PROGRAM call.
- PROGRAM_TYPE
- Optional Parameter
- The type of program.
- Values for the parameter are as follows:
- NOT_APPLIC
- PRIVATE
- SHARED
- TYPE_ANY
- PROGRAM_USAGE
- Optional Parameter
- Whether the program is used as a CICS nucleus program, or as a user application program.
- Values for the parameter are as follows:
- APPLICATION
- NUCLEUS
- PROGRAM_USE_COUNT
- Optional Parameter
- The number of times that the program has been used.
- PROGRAM_USER_COUNT
- Optional Parameter
- The number of different users that have invoked 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.
- RUNTIME_ENVIRONMENT
- Optional Parameter
- Indicates the runtime environment used to run this program.
- Values for the parameter are as follows:
- JVM_RUNTIME
- LE370_RUNTIME
- NON_LE370_RUNTIME
- NOT_APPLIC
- UNKNOWN_RUNTIME
- XPLINK_RUNTIME
- SPECIFIED_AMODE
- Optional Parameter
- The addressing mode of the program.
- Values for the parameter are as follows:
- AMODE_ANY
- AMODE_NOT_SPECIFIED
- 24
- 31
- 64
- SPECIFIED_RMODE
- Optional Parameter
- The residence mode of the program.
- Values for the parameter are as follows:
- RMODE_ANY
- RMODE_NOT_SPECIFIED
- 24