PGLD gate, LOAD function

The LOAD function of the PGLD gate is used to load a program in response to a CICS® internal load request.

Input Parameters

HOLD_LIFETIME
determines for how long the program is to be loaded; that is, for the life-time of CICS (or until explicitly deleted) or for the lifetime of the task (unless explicitly deleted by the task).
Values for the parameter are:
  • CALLER_MANAGED
  • CICS_LIFE
  • TASK_LIFE
MODULE_TYPE
is the type of program resource to be defined.
Values for the parameter are:
  • MAPSET
  • PARTITIONSET
  • PROGRAM
PROGRAM_NAME
is the name of the program resource to be defined.
SYSTEM_AUTOINSTALL
defines whether CICS is to autoinstall the program if there is no associated PROGRAM resource definition.
Values for the parameter are:
  • NO
  • YES
LPA_ELIGIBLE
Optional Parameter
defines whether or not the program can be loaded into the MVS™ link pack area (LPA).
Values for the parameter are:
  • NO
  • YES
SUSPEND
Optional Parameter
This option is passed to the LDLD call, and thence to SMGF. It specifies the action in the event of a storage shortage.YES, the default value, means that the task will be suspended until storage is available. NO means that the task will be abended.
Values for the parameter are:
  • NO
  • YES

Output Parameters

REASON
The following values are returned when RESPONSE is EXCEPTION:
  • AUTOINSTALL_FAILED
  • AUTOINSTALL_INVALID_DATA
  • AUTOINSTALL_MODEL_NOT_DEF
  • AUTOINSTALL_URM_FAILED
  • JVM_PROGRAM
  • PROGRAM_NOT_DEFINED
  • PROGRAM_NOT_ENABLED
  • PROGRAM_NOT_LOADABLE
  • REMOTE_PROGRAM
The following values are returned when RESPONSE is INVALID:
  • INVALID_FUNCTION
ENTRY_POINT
is the token defining the entry point of the program.
LOAD_POINT
is the load point address of the program returned by the loader domain on the ACQUIRE_PROGRAM call.
PROGRAM_LENGTH
is the length of the program. returned by the loader domain on the ACQUIRE_PROGRAM call.
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


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