LDLD gate, INQUIRE_PROGRAM function

The INQUIRE_PROGRAM function of the LDLD gate is used to return the details of a specific program.

Input Parameters

PROGRAM_NAME
specifies the name of the required program.
PROGRAM_TOKEN
is a valid program-identifying token as returned by a previous DEFINE or ACQUIRE request for the same program name.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • LOOP
The following values are returned when RESPONSE is EXCEPTION:
  • PROGRAM_NOT_DEFINED
The following values are returned when RESPONSE is INVALID:
  • INVALID_PROGRAM_TOKEN
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
ACCESS
Optional Parameter
is the type of storage that the program resides in.
Values for the parameter are:
  • CICS
  • NONE
  • READ_ONLY
  • USER
ENTRY_POINT
Optional Parameter
is the address of the entry point of the program instance.
EXECUTION_KEY
Optional Parameter
is the execution key for the program.
Values for the parameter are:
  • CICS
  • USER
LIBRARY
Optional parameter
is the name of the LIBRARY concatenation from which the program was loaded.
LIBRARYDSN
Optional parameter
is the name of the data set within the LIBRARY concatenation from which the program was loaded.
LOAD_POINT
Optional Parameter
is the address of the load point of the program instance.
LOCATION
Optional Parameter
determines where the program instance for which the LOAD_POINT and ENTRY_POINT have been returned resides.
Values for the parameter are:
  • CDSA
  • ECDSA
  • ELPA
  • ERDSA
  • ESDSA
  • LPA
  • NONE
  • RDSA
  • SDSA
NEW_PROGRAM_TOKEN
Optional Parameter
is the identifying token that may be used on subsequent ACQUIRE or RELEASE calls for this program name.
PROGRAM_ATTRIBUTE
Optional Parameter
reflects the program attribute from the program definition, and is used by the program manager domain to recognize RELOAD programs.
Values for the parameter are:
  • RELOAD
  • RESIDENT
  • REUSABLE
  • TEST
  • TRANSIENT
PROGRAM_LENGTH
Optional Parameter
is the length of the program instance in bytes.
PROGRAM_TYPE
Optional Parameter
is the current program copy type.
Values for the parameter are:
  • PRIVATE
  • SHARED
  • TYPE_ANY
PROGRAM_USAGE
Optional Parameter
is the current usage definition.
Values for the parameter are:
  • APPLICATION
  • NUCLEUS
PROGRAM_USE_COUNT
Optional Parameter
is the cumulative use count of the program.
PROGRAM_USER_COUNT
Optional Parameter
is the current number of users of the program.
SPECIFIED_AMODE
Optional Parameter
is the addressing mode required by CICS for the program. A program that does not have the required residency mode is not loaded. If REQUIRED_AMODE was omitted when the program was defined, AMODE_NOT_SPECIFIED is returned.
Values for the parameter are:
  • AMODE_ANY
  • AMODE_NOT_SPECIFIED
  • 24
  • 31
  • 64
SPECIFIED_RMODE
Optional Parameter
is the residency mode required by CICS for the program. A program that does not have the required residency mode is not loaded. If REQUIRED_RMODE was omitted when the program was defined, RMODE_NOT_SPECIFIED is returned.
Values for the parameter are:
  • RMODE_ANY
  • RMODE_NOT_SPECIFIED
  • 24


dfhs3_LDLDinquire_program.html | Timestamp icon Last updated: Monday, 5 June 2017