Table 79 summarizes the program manager domain’s specific
gates. It shows the level-1 trace point IDs of the modules providing the functions
for the gates, the functions provided by the gates, and whether or not the
functions are available through the exit programming interface (XPI).
Table 79. Program manager domain’s specific gates
Gate |
Trace |
Function |
XPI |
PGAI |
PG 0E01
PG 0E02
|
Kernel subroutine called internally from
program manager |
NO
NO
|
PGAQ |
PG 0401
PG 0402
|
INQUIRE_AUTOINSTALL
SET_AUTOINSTALL
|
YES
YES
|
PGCH |
PG 1700
PG 1701
 |
BIND_CHANNEL
COPY_CHANNEL
CREATE_CHANNEL
DELETE_CHANNEL
DELETE_OWNED_CHANNELS
DETACH_CHANNEL
INQUIRE_BOUND_CHANNEL
INQUIRE_CHANNEL
INQUIRE_CHANNEL_BY_TOKEN
INQUIRE_CURRENT_CHANNEL
RENAME_CHANNEL
SET_CURRENT_CHANNEL
 |
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
 |
PGCP |
PG 1800
PG 1801
 |
COPY_CONTAINER_POOL
CREATE_CONTAINER_POOL
DELETE_CONTAINER_POOL,
INQUIRE_CONTAINER_POOL
 |
NO
NO
NO
NO
 |
PGCR |
PG 1900
PG 1901
 |
COPY_CONTAINER
DELETE_CONTAINER
ENDBR_CONTAINER
GET_CONTAINER_INTO
GET_CONTAINER_LENGTH
GET_CONTAINER_SET
GETNEXT_CONTAINER
INQUIRE_BROWSE_CONTEXT
INQUIRE_CONTAINER
INQUIRE_CONTAINER_BY_TOKEN
MOVE_CONTAINER
PUT_CONTAINER
SET_CONTAINER
TRACE_CONTAINERS
 |
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
 |
PGDD |
PG 0301
PG 0302
|
DEFINE_PROGRAM
DELETE_PROGRAM
|
NO
NO
|
PGEX |
PG 0C01
PG 0C02
|
INITIALIZE_EXIT
TERMINATE_EXIT
|
NO
NO
|
PGHM |
PG 0700
PG 0701
|
SET_CONDITIONS
IGNORE_CONDITIONS
INQ_CONDITION
SET_AIDS
INQ_AID
SET_ABEND
INQ_ABEND
PUSH_HANDLE
POP_HANDLE
FREE_HANDLE_TABLES
CLEAR_LABELS
|
NO
NO
|
PGIS |
PG 0500
PG 0501
|
INQUIRE_PROGRAM
INQUIRE_CURRENT_PROGRAM
SET_PROGRAM
START_BROWSE_PROGRAM
GET_NEXT_PROGRAM
END_BROWSE_PROGRAM
REFRESH_PROGRAM
|
YES
YES
YES
YES
YES
YES
NO
|
PGLD |
PG 0601
PG 0602
|
LOAD_EXEC
LOAD
RELEASE_EXEC
RELEASE
|
NO
NO
NO
NO
|
PGLE |
PG 1101
PG 1102
|
LINK_EXEC
|
NO
|
PGLK |
PG 0B01
PG 0B02
|
LINK
LINK_PLT
|
NO
NO
|
PGLU |
PG 0A01
PG 0A02
|
LINK_URM
|
NO
NO
|
PGPG |
PG 0901
PG 0902
|
INITIAL_LINK
|
NO
NO
|
PGRE |
PG 1201
PG 1202
|
PREPARE_RETURN_EXEC
|
NO
|
PGXE |
PG 1301
PG 1302
|
PREPARE_XCTL_EXEC
|
NO
NO
|
PGXM |
PG 0901
PG 0902
|
INITIALIZE_TRANSACTION
TERMINATE_TRANSACTION
|
NO
NO
|
Note:
PGRE is only called for EXEC RETURN statements which have input parameters
(COMMAREA, INPUTMSG, or TRANSID) specified. If no input parameters are specified,
there is no trace of PGRE after the EIP trace of the RETURN statement. |
The INQUIRE_AUTOINSTALL function of the PGAQ gate is used to inquire about
attributes of the program autoinstall function.
Input parameters
None.
Output parameters
- [AUTOINSTALL_STATE]
- is the state of the program autoinstall function. It can have either
of these values:
ACTIVE|INACTIVE
- [AUTOINSTALL_CATALOG]
- identifies if program autoinstall events are cataloged. It can have
any of these values:
MODIFY|NONE|ALL
- [AUTOINSTALL_EXIT_NAME]
- is the name of the program autoinstall exit program.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FUNCTION |
The SET_AUTOINSTALL function of the PGAQ gate is used to set attributes
of the program autoinstall function.
Input parameters
- [AUTOINSTALL_STATE]
- is the state of the program autoinstall function. It can have either
of these values:
ACTIVE|INACTIVE
- [AUTOINSTALL_CATALOG]
- identifies if program autoinstall events are cataloged. It can have
any of these values:
MODIFY|NONE|ALL
- [AUTOINSTALL_EXIT_NAME]
- is the name of the program autoinstall exit program.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FUNCTION |
The BIND_CHANNEL function of the PGCH gate is used to make the specified
channel the channel used on the initial link.
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel to be used on the initial link.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ALREADY_SET
|
INVALID |
INVALID_LINK_LEVEL
INVALID_TOKEN
|
- CHANNEL_ALREADY_SET
- Only one bind can occur for each task.
- INVALID_LINK_LEVEL
- The command was executed outside a program manager environment.
- INVALID_TOKEN
- The specified token does not address a channel control block.

The COPY_CHANNEL function of the PGCH gate is used to take a copy of a
channel and all its containers. The copy has the same name as the original,
but is not on any chain. This function is required by the START command.
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel to be copied.
Output parameters
- COPIED_CHANNEL_TOKEN
- A token referencing a copy of the specified channel (used on START and
RETURN commands).
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_TOKEN
|
- INVALID_TOKEN
- The specified token does not address a channel control block.

The CREATE_CHANNEL function of the PGCH gate is used to create a channel.
Input parameters
- [CCSID]
- is the default coded character set identifier (CCSID) for character
data in this channel.
- CHANNEL_NAME
- is the 16-character name of the channel to be created.
- [CURRENT_CHANNEL]
- whether or not the created channel is to be the current channel of the
current link level. It can have either of these values:
YES|NO
- [LINK_LEVEL]
- whether the channel is to be created on the current chain, the previous
link level’s chain, or on no chain (NONE). LINK_LEVEL can have any of
these values:
CURRENT|PREVIOUS|NONE
NONE is used when creating a
channel for transfer on a START or RETURN command.
Output parameters
- [CHANNEL_TOKEN]
- is a token referencing the newly-created channel.
- [CONTAINER_POOL_TOKEN]
- is a token to access a pool of containers.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ALREADY_EXISTS
CHANNEL_ALREADY_SET
|
INVALID |
CCSID_INVALID
INVALID_CHANNEL_NAME
INVALID_LINK_LEVEL
INVALID_PARAMETERS
INVALID_TOKEN
|
- CCSID_INVALID
- The specified CCSID is incorrect.
- CHANNEL_ALREADY_EXISTS
- A channel with this name already exists.
- CHANNEL_ALREADY_SET
- Only one current channel is possible.
- INVALID_CHANNEL_NAME
- The channel name contains invalid characters.
- INVALID_LINK_LEVEL
- A link-level of PREVIOUS was specified in a top-level program, or the
command is executed outside a program manager environment.
- INVALID_PARAMETERS
- You have specified an invalid combination of parameters.
- INVALID_TOKEN
- The specified token does not address a channel control block.

The DELETE_CHANNEL function of the PGCH gate is used to delete a channel.
This command can be used to delete channels when they are bound to principal
facilities, but not to PLCBs.
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel to be deleted.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ATTACHED
|
INVALID |
INVALID_TOKEN
|
- CHANNEL_ATTACHED
- The channel is attached to PLCB chain and cannot be deleted.
- INVALID_TOKEN
- The specified token does not address a channel control block.

The DELETE_OWNED_CHANNELS function of the PGCH gate is used to delete all
channels from the channel chain. If the current channel is owned by this link
level, it is deleted as well. The container pool associated with each channel
is also deleted. This ends any browse in progress and deletes all containers.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_LINK_LEVEL
|
- INVALID_LINK_LEVEL
- The command was executed outside a program manager environment.

The DETACH_CHANNEL function of the PGCH gate is used to detach a channel.
The channel may be the current channel, or on the PLCB chain. The channel’s
containers are only deleted if DELETE(YES) is specified. It is implied that
a SET_CURRENT_CHANNEL will be done with this channel at some time.
A channel can only be detached from the current link level.
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel to be detached.
- [DELETE]
- whether the channel’s containers should be deleted. DELETE can have
either of these values:
YES|NO
- [FREE_SET_STORAGE]
- whether the channel’s storage should be freed. FREE_SET_STORAGE
can have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_NOT_FOUND
|
INVALID |
INVALID_TOKEN
INVALID_LINK_LEVEL
|
- CHANNEL_NOT_FOUND
- The channel was not found on the PLCB channel chain.
- INVALID_LINK_LEVEL
- The command was executed outside a program manager environment.
- INVALID_TOKEN
- The specified token does not address a channel control block.

The INQUIRE_BOUND_CHANNEL function of the PGCH gate is used to get information
about the channel that is bound to the current transaction. This may or may
not be the current channel. This request may be issued outside a program manager
environment.
Output parameters
- [CHANNEL_TOKEN]
- is a token referencing the bound channel.
- [CHANNEL_NAME]
- is the name of the bound channel.
- [CONTAINER_POOL_TOKEN]
- is a token referencing the container pool of the bound channel.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_NOT_FOUND
|
- CHANNEL_NOT_FOUND
- There is no bound channel.

The INQUIRE_CHANNEL function of the PGCH gate is used to retrieve the properties
of a named channel, including its address (returned as a token). To find the
named channel, CICS scans the channels accessible from the specified link
level.
Input parameters
- CHANNEL_NAME
- is the name of the channel to be to be enquired upon.
- [LINK_LEVEL]
- whether the named channel is on the current chain or the previous link
level’s chain. LINK_LEVEL can have either of these values:
CURRENT|PREVIOUS
Output parameters
- [CCSID]
- is the default coded character set identifier (CCSID) for character
data in the named channel.
- [CHANNEL_TOKEN]
- is a token referencing the named channel.
- [CONTAINER_POOL_TOKEN]
- is a token referencing the container pool of the named channel.
- [CURRENT_CHANNEL]
- whether the named channel is the current channel. CURRENT_CHANNEL can
have either of these values:
YES|NO
- [OWNER]
- whether the named channel is owned by the specified link level. OWNER
can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_NOT_FOUND
|
INVALID |
INVALID_LINK_LEVEL
|
- CHANNEL_NOT_FOUND
- No channel can be found at the specified link level.
- INVALID_LINK_LEVEL
- A link-level of PREVIOUS was specified in a top-level program, or the
command was executed outside a program manager environment.

The INQUIRE_CHANNEL_BY_TOKEN function is used to retrieve the properties
of a channel (which is specified by token).
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel to be enquired upon.
Output parameters
- [CCSID]
- is the default coded character set identifier (CCSID) for character
data in the specified channel.
- [CHANNEL_NAME]
- is the name of the specified channel.
- [CONTAINER_POOL_TOKEN]
- is a token referencing the container pool of the specified channel.
- [CURRENT_CHANNEL]
- whether the specified channel is the current channel. CURRENT_CHANNEL
can have either of these values:
YES|NO
- [OWNER]
- whether the specified channel is owned by the specified link level.
OWNER can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_TOKEN
|
INVALID |
INVALID_LINK_LEVEL
|
- CHANNEL_NOT_FOUND
- No channel can be found at the specified link level.
- INVALID_LINK_LEVEL
- A link-level of PREVIOUS was specified in a top-level program, or the
command was executed outside a program manager environment.
- INVALID_TOKEN
- The specified token does not address a channel control block.

The INQUIRE_CURRENT_CHANNEL function of the PGCH gate is used to retrieve
the properties of the current channel.
Output parameters
- [CCSID]
- is the default coded character set identifier (CCSID) for character
data in the current channel.
- [CHANNEL_NAME]
- is the name of the current channel.
- [CHANNEL_TOKEN]
- is a token referencing the current channel.
- [CONTAINER_POOL_TOKEN]
- is a token referencing the container pool of the current channel.
- [OWNER]
- whether the current channel is owned by the specified link level. OWNER
can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_NOT_FOUND
|
INVALID |
INVALID_LINK_LEVEL
|
- CHANNEL_NOT_FOUND
- The current link level was not passed a channel.
- INVALID_LINK_LEVEL
- The command was executed outside a program manager environment.

The RENAME_CHANNEL function of the PGCH gate is used to rename a channel.
Input parameters
- CHANNEL_NAME
- is the new name of the channel, after it has been renamed.
- CHANNEL_TOKEN
- is a token referencing the channel to be renamed. The token must have
been obtained using the INQUIRE_CHANNEL command.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ALREADY_EXISTS
INVALID_CHANNEL_NAME
INVALID_TOKEN
|
- CHANNEL_ALREADY_EXISTS
- A channel with the specified channel name already exists.
- INVALID_CHANNEL_NAME
- The new channel name contains invalid characters.
- INVALID_TOKEN
- The specified channel token does not address a channel control block.

The SET_CURRENT_CHANNEL function of the PGCH gate is used to make the specified
channel the current channel for the current link level.
If OWNER(YES) is specified, the channel is added to the current link level’s
chain.
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel that is to become the current channel
for this link level.
- [OWNER]
- whether the specified channel is owned by the current link level. If
OWNER(YES) is specified, the channel is added to the current link level’s
chain. OWNER can have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ALREADY_EXISTS
INVALID_TOKEN
|
INVALID |
INVALID_LINK_LEVEL
|
- CHANNEL_ALREADY_EXISTS
- A channel with the same name as the specified channel already exists
on the current link level’s chain.
- INVALID_LINK_LEVEL
- The command was executed outside a program manager environment.
- INVALID_TOKEN
- The specified channel token does not address a channel control block.

The COPY_CONTAINER_POOL function of the PGCP gate is used to copy all the
containers in a container pool to another container pool.
Input parameters
- POOL_TOKEN
- is a token (returned on a CREATE_CONTAINER_POOL request) that identifies
the container pool to be copied.
Output parameters
- COPIED_POOL_TOKEN
- is a token that maps to the pool to which all containers have been copied
from the pool referenced by POOL_TOKEN.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_POOL_TOKEN |

The CREATE_CONTAINER_POOL function of the PGCP gate is used to create a
container pool.
Input parameters
- [CCSID]
- is the default coded character set identifier of the character data
in the pool to be created.
Output parameters
- POOL_TOKEN
- is a token that references the container pool that has been created.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_POOL_TOKEN |

The DELETE_CONTAINER_POOL function of the PGCP gate is used to delete a
container pool.
Input parameters
- POOL_TOKEN
- is a token that identifies the container pool to be deleted.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_POOL_TOKEN |

The INQUIRE_CONTAINER_POOL function of the PGCP gate is used to inquire
about the attributes of a container pool.
Input parameters
- POOL_TOKEN
- is a token that identifies the container pool to be inquired upon.
Output parameters
- [CCSID]
- is the default coded character set identifier (CCSID) for character
data in the containers in the pool.
- [NUMBER_OF_CONTAINERS]
- is the number of containers that the pool contains.
- [POOL_SIZE]
- is the size, in bytes, of the data in the pool.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_POOL_TOKEN |

The COPY_CONTAINER function of the PGCR gate is used to copy a container
from one container pool to another. Both pools must already have been created.
Input parameters
- [AS_CONTAINER_NAME]
- is the name by which the copied container is to be known in the target
container pool.
- [CONTAINER_NAME]
- is the name of the container to be copied.
- [CONTAINER_TOKEN]
- is a token referencing the container to be copied.
- [POOL_TOKEN]
- is a token referencing the source container pool (that is, the pool
from which the container is to be copied).
- [TO_POOL_TOKEN]
- is a token referencing the target container pool (that is, the pool
to which the container is to be copied).
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
Output parameters
- [CONTAINER_TOKEN_OUT]
- is a token representing the new copy of the container.
- [GENERATION_NUMBER]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was last changed.
- [INITIAL_GENERATION]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was created.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CONTAINER_NOT_FOUND
INVALID_AS_CONTAINER_NAME
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_POOL_TOKEN
INVALID_PARAMETERS
INVALID_TO_POOL_TOKEN
|

The DELETE_CONTAINER function of the PGCR gate is used to delete a container
and its data. The container is identified using its name, the container pool
to which it belongs, and its type.
Input parameters
- [CALLER]
- is the call part of an API call. It can have either of these values:
EXEC|SYSTEM
- [CONTAINER_NAME]
- is the name of the container to be deleted.
- [CONTAINER_TOKEN]
- is a token representing the container to be deleted.
- [POOL_TOKEN]
- is a token referencing the container pool that contains the container
to be deleted.
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CONTAINER_NOT_FOUND
READONLY_CONTAINER
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_PARAMETERS
INVALID_POOL_TOKEN
|

The ENDBR_CONTAINER function of the PGCR gate is used to end a browse of
containers.
Input parameters
- BROWSE_TOKEN
- is a browse token referencing the next container in the container pool
being browsed.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_BROWSE_TOKEN
|

The GET_CONTAINER function of the PGCR gate is used to get the data from
a container into an area provided by the caller. The container is identified
using a pool token, together with the container’s name and type. Note
that LENGTH_ERROR indicates that as much data as possible has been copied.
It is the user's responsibility that DATA_TOKEN_OUT is specified on the
next call as DATA_TOKEN_IN. The first call doesn't have a DATA_TOKEN_IN.
Input parameters
- [CALLER]
- is the call part of an API call. It can have either of these values:
EXEC|SYSTEM
- [CCSID]
- if conversion is specified (see the CONVERT option), CCSID is the coded
character set identifier to which the character data in the container should
be converted.
- [CONTAINER_NAME]
- is the name of the container from which the data is to be obtained.
- [CONTAINER_TOKEN]
- is a token representing the container from which the data is to be obtained.
- [CONVERT]
- whether the data in the container should be converted. It can have either
of these values:
YES|NO
The default value is YES.
- [DATA_TOKEN_IN]
- is a token referencing the data in the container.
The value returned
in DATA_TOKEN_OUT on one GET_CONTAINER_INTO call must be specified on the
next call as DATA_TOKEN_IN. (The first GET_CONTAINER_INTO call for this container
doesn't have a DATA_TOKEN_IN.)
- ITEM_BUFFER
- On input, ITEM_BUFFER_P is a pointer to a receiving area of length ITEM_BUFFER_M.
On output, the value ITEM_BUFFER_N is set to the actual length returned.
- [POOL_TOKEN]
- is a token referencing the container pool to which the container belongs.
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
Output parameters
- [CONTAINER_CCSID]
- is the coded character set identifier of the extracted data.
- [DATA_TOKEN_OUT]
- is a token referencing the data in the container.
The value returned
in DATA_TOKEN_OUT on one GET_CONTAINER_INTO call must be specified on the
next call as DATA_TOKEN_IN. (The first GET_CONTAINER_INTO call for this container
doesn't have a DATA_TOKEN_IN.)
- [DATATYPE]
- is the format of the data. It can have either of these values:
CHAR|BIT
- [GENERATION_NUMBER]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was last changed.
- [INITIAL_GENERATION]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was created.
- [USERACCESS]
- whether USER containers can be updated by API commands. USERACCESS can
have either of these values:
READONLY|ANY
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CCSID_CONVERSION_ERROR
CCSID_INVALID
CCSID_PAIR_UNSUPPORTED
CCSID_PARTIAL_CONVERSION
CONTAINER_NOT_FOUND
INVALID_DATA_TOKEN_IN
LENGTH_ERROR
MORE_DATA
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_POOL_TOKEN
INVALID_PARAMETERS
|

The GET_CONTAINER_LENGTH function of the PGCR gate is used to discover
the length, in bytes, of the data in a container.
Input parameters
- [CALLER]
- is the call part of an API call. It can have either of these values:
EXEC|SYSTEM
- [CCSID]
- is the coded character set identifier to which the character data in
the container should be converted.
- [CONTAINER_NAME]
- is the name of the container that holds the data.
- [CONTAINER_TOKEN]
- is a token representing the container that holds the data.
- [POOL_TOKEN]
- is a token referencing the container pool to which the container belongs.
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
Output parameters
- [CONTAINER_CCSID]
- is the coded character set identifier of the character data in the container.
- [DATA_LENGTH]
- is the length, in bytes, of the data in the container. If the container
holds character data that has been converted from one CCSID to another, this
is the length of the converted data.
- [DATATYPE]
- is the format of the data. It can have either of these values:
CHAR|BIT
- [GENERATION_NUMBER]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was last changed.
- [INITIAL_GENERATION]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was created.
- [USERACCESS]
- whether USER containers can be updated by API commands. USERACCESS can
have either of these values:
READONLY|ANY
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CCSID_CONVERSION_ERROR
CCSID_IGNORED
CCSID_INVALID
CCSID_PAIR_UNSUPPORTED
CCSID_PARTIAL_CONVERSION
CONTAINER_NOT_FOUND
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_PARAMETERS
INVALID_POOL_TOKEN
|

The GET_CONTAINER_SET function of the PGCR gate is used to get the data
from a container and copy it into an area provided by the CICS program domain.
The container is identified using a pool token, together with its name and
type.
Input parameters
- [CALLER]
- is the call part of an API call. It can have either of these values:
EXEC|SYSTEM
- [CCSID]
- if conversion is specified (see the CONVERT option), CCSID is the coded
character set identifier to which the character data in the container should
be converted.
- [CONTAINER_NAME]
- is the name of the container from which the data is to be obtained.
- [CONTAINER_TOKEN]
- is a token representing the container from which the data is to be obtained.
- [CONVERT]
- whether the data in the container should be converted. It can have either
of these values:
YES|NO
The default value is YES.
- [POOL_TOKEN]
- is a token referencing the container pool to which the container belongs.
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
Output parameters
- [CONTAINER_CCSID]
- is the coded character set identifier of the extracted data.
- [DATATYPE]
- is the format of the data. It can have either of these values:
CHAR|BIT
- [GENERATION_NUMBER]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was last changed.
- [INITIAL_GENERATION]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was created.
- ITEM_DATA
- The address and length of the SET storage returned.
- [USERACCESS]
- whether USER containers can be updated by API commands. USERACCESS can
have either of these values:
READONLY|ANY
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CCSID_CONVERSION_ERROR
CCSID_IGNORED
CCSID_INVALID
CCSID_PAIR_UNSUPPORTED
CCSID_PARTIAL_CONVERSION
CONTAINER_NOT_FOUND
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_PARAMETERS
INVALID_POOL_TOKEN
|

The GETNEXT_CONTAINER function of the PGCR gate is used to get the next
container in a browse of containers.
Input parameters
- BROWSE_TOKEN
- is a browse token referencing the next container in a browse of containers.
Output parameters
- [CCSID]
- is the coded character set identifier of the character data in the container.
- [CONTAINER_NAME]
- is the name of the container.
- [CONTAINER_TOKEN]
- is a token referencing the container.
- [DATA_LENGTH]
- is the length, in bytes, of the data in the container.
- [DATATYPE]
- is the format of the data in the container. DATATYPE can have either
of these values:
CHAR|BIT
- [GENERATION_NUMBER]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was last changed.
- [INITIAL_GENERATION]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was created.
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
- [USERACCESS]
- whether the container can be updated by API commands. USERACCESS can
have either of these values:
READONLY|ANY
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
BROWSE_END
INVALID_BROWSE_TOKEN
|

The INQUIRE_BROWSE__CONTEXT function of the PGCR gate is used to
Input parameters
- BROWSE_TOKEN
- is a browse token referencing the next container in a browse of containers.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_BROWSE_TOKEN
|

The INQUIRE_CONTAINER function of the PGCR gate is used to retrieve the
attributes of a container.
CCSID is the coded character set identifier that the character data in
the container is stored in.
Input parameters
- [CALLER]
- is the call part of an API call. It can have either of these values:
EXEC|SYSTEM
- CONTAINER_NAME
- is the name of the container to be enquired upon.
- POOL_TOKEN
- is a token referencing the container pool to which the container belongs.
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
Output parameters
- [CCSID]
- is the coded character set identifier of the character data in the container.
- [CONTAINER_TOKEN]
- is a token referencing the container.
- [DATATYPE]
- is the format of the data. It can have either of these values:
CHAR|BIT
- [DATA_LENGTH]
- is the length, in bytes, of the data in the container.
- [GENERATION_NUMBER]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was last changed.
- [INITIAL_GENERATION]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was created.
- [USERACCESS]
- whether USER containers can be updated by API commands. USERACCESS can
have either of these values:
READONLY|ANY
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CONTAINER_NOT_FOUND
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_PARAMETERS
INVALID_POOL_TOKEN
|

The INQIRE_CONTAINER_BY_TOKEN function of the PGCR gate is used to retrieve
the attributes of a container by means of a token.
Input parameters
- CONTAINER_TOKEN
- is a token referencing the container to be enquired upon.
Output parameters
- [CCSID]
- is the coded character set identifier of the character data in the container.
- [CONTAINER_NAME]
- is the name of the container.
- [DATA_LENGTH]
- is the length, in bytes, of the data in the container.
- [DATATYPE]
- is the format of the data. It can have either of these values:
CHAR|BIT
- [GENERATION_NUMBER]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was last changed.
- [INITIAL_GENERATION]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was created.
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
- [USERACCESS]
- whether USER containers can be updated by API commands. USERACCESS can
have either of these values:
READONLY|ANY
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CONTAINER_NOT_FOUND
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_PARAMETERS
|

The MOVE_CONTAINER function of the PGCR gate is used to move a container
from one container pool to another. Both pools must already have been created.
If the TO_POOL_TOKEN is not specified, the container is not moved to a different
pool but is renamed to the value of AS_CONTAINER_NAME.
Input parameters
- [AS_CONTAINER_NAME]
- is the name by which the container is to be known in the target container
pool.
- [CALLER]
- is the call part of an API call. It can have either of these values:
EXEC|SYSTEM
- [CONTAINER_NAME]
- is the name of the container to be moved.
- [CONTAINER_TOKEN]
- is a token representing the container to be moved.
- [POOL_TOKEN]
- is a token referencing the container pool from which the container is
to be moved.
- [TO_POOL_TOKEN]
- is a token referencing the container pool to which the container is
to be moved.
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
Output parameters
- [CONTAINER_TOKEN_OUT]
- is a token representing the moved container in the target container
pool.
- [GENERATION_NUMBER]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was last changed.
- [INITIAL_GENERATION]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was created.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CONTAINER_NOT_FOUND
INVALID_AS_CONTAINER_NAME
READONLY_AS_CONTAINER
READONLY_CONTAINER
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_PARAMETERS
INVALID_POOL_TOKEN
INVALID_TO_POOL_TOKEN
|

The PUT_CONTAINER function of the PGCR gate is used to put data into a
container from an area provided by the caller.
Input parameters
- [CALLER]
- is the call part of an API call. It can have either of these values:
EXEC|SYSTEM
- [CCSID]
- is the coded character set identifier (CCSID) of the character data
to be put into the container.
- [CONTAINER_NAME]
- is the name of the container.
- [CONTAINER_TOKEN]
- is a token referencing an existing container into which the data is
to be put.
- [CONVERT]
- whether character data in the container should be converted. It can
have either of these values:
YES|NO
The default value is YES.
- [DATATYPE]
- is the format of the data. It can have either of these values:
CHAR|BIT
- ITEM_DATA
- The address and length of the put data.
- [POOL_TOKEN]
- is a token referencing the container pool to which the container belongs.
- [PUT_TYPE]
- whether the PUT data should be appended to the current contents of the
container or replace the current contents. PUT_TYPE can have either of these
values:
APPEND|REPLACE
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
- [USERACCESS]
- whether USER containers can be updated by API commands. USERACCESS can
have either of these values:
READONLY|ANY
Output parameters
- [CONTAINER_TOKEN_OUT]
- is a token referencing the container.
- [GENERATION_NUMBER]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was last changed.
- [INITIAL_GENERATION]
- Every time a container in a container pool is changed or created the
pool generation number is incremented. This number is the number for the container
when the container was created.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CCSID_INVALID
DATATYPE_CHANGE
INVALID_CONTAINER_NAME
LENGTH_ERROR,
READONLY_CONTAINER
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_PARAMETERS
INVALID_POOL_TOKEN
|

The SET_CONTAINER function of the PGCR gate is used to change the attributes
of a container.
Input parameters
- [CONTAINER_NAME]
- is the name of the container.
- [CONTAINER_TOKEN]
- is a token referencing the container whose attributes are to be changed.
- [POOL_TOKEN]
- is a token referencing the container pool to which the container belongs.
- [TYPE]
- whether the container is visible only to CICS, or to user programs as
well. TYPE can have either of these values:
CICS|USER
- [USERACCESS]
- whether USER containers can be updated by API commands. USERACCESS can
have either of these values:
READONLY|ANY
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CONTAINER_NOT_FOUND
|
INVALID |
INVALID_CONTAINER_TOKEN
INVALID_PARAMETERS
INVALID_POOL_TOKEN
|

The STARTBR_CONTAINER function of the PGCR gate is used to initiate a browse
of the containers in a specified container pool.
Input parameters
- POOL_TOKEN
- is a token referencing the container pool to be browsed.
- [CALLER]
- is the call part of an API call. It can have either of these values:
EXEC|SYSTEM
Output parameters
- BROWSE_TOKEN
- is a browse token referencing a container in the container pool. This
container is the first in the browse list.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_POOL_TOKEN
|

The TRACE_CONTAINER function of the PGCR gate is used to initiate a trace
of the containers in a specified channel.
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel whose containers are to be traced.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_CHANNEL_TOKEN
|
The DEFINE_PROGRAM function of the PGDD gate is used to define a program
resource.
Input parameters
Note:
Specify either the PROGRAM_NAME parameter or the CATALOG_ADDRESS
parameter, not both.
- PROGRAM_NAME
- is the name of the program resource to be defined.
- CATALOG_ADDRESS
- is the token identifying the program resource to be defined.
- [CEDF_STATUS]
- indicates whether or not the EDF diagnostic screens are displayed when
the program is running under the control of the execution diagnostic facility
(EDF). It can have either of these values:
CEDF|NOCEDF
- [LANGUAGE_DEFINED]
- is the language to be defined for the program. It can have any of these
values:
ASSEMBLER|C370|COBOL|LE370|PLI|NOT_DEFINED
- [AVAIL_STATUS]
- defines whether (ENABLED) or not (DISABLED) the program can be used.
It can have either of these values:
ENABLED|DISABLED
- [MODULE_TYPE]
- is the type of program resource to be defined: It can have any of these
values:
PROGRAM|MAPSET|PARTITIONSET
- [DATA_LOCATION]
- defines whether the program can handle only 24-bit addresses (data located
below the 16MB line) can handle 31-bit addresses (data located above or below
the 16MB line). The DATALOCATION options are independent from the addressing
mode of the link-edited program. It can have either of these values:
ANY|BELOW
- [EXECUTION_SET]
- indicates whether you want CICS® to 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). It can have either of these values:
FULLAPI|DPLSUBSET
- [REMOTE_PROGID]
- is 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]
- is the name of a remote CICS region if you want CICS to ship a distributed
program link (DPL) request to another CICS region.
- [REMOTE_TRANID]
- is the name of the transaction you want the remote CICS to attach, and
under which it is to run the remote program.
- [EXECUTION_KEY]
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER
Note:
If the program is link-edited
with the RENT attribute and the RMODE(ANY) mode statement, CICS loads the
program into extended the 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.
- [PROGRAM_TYPE]
- is the type of program. It can have any of these values:
PRIVATE|SHARED|TYPE_ANY
- [PROGRAM_USAGE]
- defines whether the program is to be used as a CICS nucleus program
or as a user application program. It can have either of these values:
NUCLEUS|APPLICATION
- [PROGRAM_ATTRIBUTE]
- defines the residence status of the program, and when the storage for
this program is released. It can have any of these values:
RESIDENT|REUSABLE|TRANSIENT|RELOAD|TEST
- [REQUIRED_AMODE]
- is the addressing mode of the program. It can have any of these values:
24|31|AMODE_ANY
- [REQUIRED_RMODE]
- is the residence mode of the program. It can have any of these values:
24|RMODE_ANY
- [DYNAMIC_STATUS]
- indicates whether or not a request to LINK to the program may be dynamically
routed. It can have either of these values:
DYNAMIC|NOTDYNAMIC
- [CONCURRENCY]
- indicates whether the program is threadsafe or only quasi-reentrant.
It can have either of these two values:
THREADSAFE|QUASIRENT
- [JVM]
- indicates whether or not the program is to be executed under the control
of a JVM (Java™ Virtual Machine). It can have either of these
values:
YES|NO
- [JVM_CLASS]
- is the name of the main class in a Java program to be run under the
control of a JVM.
- [HOTPOOL]
- indicates whether or not the Java program object is to be run in a
preinitialized Language Environment® enclave reused by multiple
invocations of the program, under control of an H8 TCB. It can have either
of these two values:
YES|NO
- [JVM_PROFILE]
- specifies the name of the data set member that contains the JVM profile..
The named profile provides the attributes of the JVM that is needed to execute
the program.
- [MULTITCB]
- is reserved for future use
- [OPENAPI]
- is reserved for future use
- [NEW_PROGRAM_TOKEN]
- is the Loader Domain token for the program
Output parameters
- NEW_PROGRAM_TOKEN
- is the token assigned to program.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
CATALOG_NOT_OPERATIONAL
CATALOG_ERROR
INSUFFICIENT_STORAGE
LOCK_ERROR
|
EXCEPTION |
PROGRAM_ALREADY_DEFINED
PROGRAM_IN_USE
|
INVALID |
INVALID_CATALOG_ADDRESS
INVALID_FUNCTION
INVALID_MODE_COMBINATION
INVALID_PROGRAM_NAME
INVALID_TYPE_ATTRIB_COMBIN
|
The DELETE_PROGRAM function of the PGDD gate is used to delete a program
resource.
Input parameters
- PROGRAM_NAME
- is the name of the program resource to be defined.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOCK_ERROR
|
EXCEPTION |
PROGRAM_NOT_DEFINED
PROGRAM_NAME_STARTS_DFH
PROGRAM_IS_URM
PROGRAM_IN_USE
|
INVALID |
INVALID_FUNCTION |
The INITIALIZE_EXIT function of the PGEX gate is used to initialize an
exit program.
Input parameters
- PROGRAM_NAME
- is the name, 1 through 8 alphanumeric characters, of the program to
be initialized.
- LOAD_PROGRAM
- defines whether or not the program is to be loaded when initialized.
It can have either of these values:
YES|NO
- SYSTEM_AUTOINSTALL
- defines whether CICS is to autoinstall the program if there is no associated
PROGRAM resource definition. It can have either of these values:
YES|NO
- [LPA_ELIGIBLE]
- defines whether or not the program can be loaded into the MVS™ link pack area
(LPA). It can have either of these values:
YES|NO
Output parameters
- PROGRAM_TOKEN
- is the token assigned to program.
- [ENTRY_POINT]
- is the token defining the entry point of the program.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
AUTOINSTALL_URM_FAILED
AUTOINSTALL_MODEL_NOT_DEF
AUTOINSTALL_INVALID_DATA
AUTOINSTALL_FAILED
JVM_PROGRAM
PROGRAM_NOT_AUTHORIZED
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
REMOTE_PROGRAM
|
INVALID |
INVALID_INITIALIZE_REQUEST
INVALID_FUNCTION
|
The TERMINATE_EXIT function of the PGEX gate is used to terminate an exit
program.
Input parameters
- PROGRAM_TOKEN
- is the token identifying the program to be terminated.
- RELEASE_PROGRAM
- defines whether or not the program is to be released when terminated.
It can have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
PROGRAM_NOT_AUTHORIZED
PROGRAM_NOT_DEFINED
PROGRAM_NOT_IN_USE
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
|
INVALID |
INVALID_PROGRAM_TOKEN
INVALID_FUNCTION
|
The SET_CONDITIONS function of the PGHM gate is used to process for user
EXEC CICS HANDLE CONDITION commands, and to save the details of the condition
into the current condition handle table.
Input parameters
- IDENTIFIERS
- is the token identifying the conditions to be handled.
- LABELS_FLAGS
- is the token identifying the number of conditions in this command that
have associated labels.
- [LABELS]
- is the token identifying the condition labels (the locations within
the program to be branched to if the condition occurs).
- [LANGUAGE]
- is the program language. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI
- [CURRENT_EXECUTION_KEY]
- is an 8-bit value indicating the current program execution key (at the
time the EXEC CICS HANDLE CONDITION command was issued).
- [USERS_RSA_POINTER]
- is the address of the user program Register Save Area into which the
program’s registers are saved at each EXEC CICS command execution.
- [AMODE]
- is the addressing mode (24-bit or 31-bit) of the program
at the time the handle command was driven.
Output parameters
- [FASTPATH_FLAGS]
- identifies the fastpath flag settings for the following conditions handled
by the user: RDATT, WRBRK, EOF, NOSPACE, QBUSY, NOSTG, ENQBUSY, NOJBUFSP,
SIGNAL, OVERFLOW, SYSBUSY, SESSBUSY.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The INQ_CONDITION function of the PGHM gate is invoked when a condition
has occurred, and returns to the caller about details of the condition for
user EXEC CICS HANDLE CONDITION commands.
Input parameters
- CONDITION
- is an 8-bit value identifying the condition.
Output parameters
- STATUS
- identifies the status of the condition. It can have any of these values:
DEFAULT|HANDLED|IGNORED
- [LABEL]
- is the token identifying the condition label within the program to be
branched to if the condition occurs.
- [LANGUAGE]
- is the program language. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI
- [CURRENT_EXECUTION_KEY]
- is an 8-bit value indicating the current program execution key (at the
time the EXEC CICS HANDLE CONDITION command was issued).
- [USERS_RSA_POINTER]
- is the address of the user program Register Save Area into which the
program’s registers are saved at each EXEC CICS command execution.
- [PROGRAM_MASK]
- identifies the program mask at the time the HANDLE CONDITION command
was executed.
- [GOTOL]
- is the token identifying the condition label within the program to be
branched to if the condition is ignored.
- [ABEND_CODE]
- is the four-character abend code to be issued if CICS drives the system
default, which is to abend the transaction.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The IGNORE_CONDITIONS function of the PGHM gate is used to ignore the conditions
for user EXEC CICS IGNORE CONDITION commands.
Input parameters
- IDENTIFIERS
- is the token identifying the conditions to be ignored.
Output parameters
- [FASTPATH_FLAGS]
- identifies the fastpath flag settings for the conditions.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The SET_AIDS function of the PGHM gate is invoked in response to a user
EXEC CICS HANDLE AID command, and saves the details of the handle into the
current aid Handle Table.
Input parameters
- IDENTIFIERS
- is the token identifying the aids to be handled.
- LABELS_FLAGS
- is the token identifying the number of aids in this command that have
associated labels.
- [LABELS]
- is the token identifying the condition labels (the locations within
the program to be branched to if the aid occurs).
- [LANGUAGE]
- is the program language. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI
- [CURRENT_EXECUTION_KEY]
- is an 8-bit value indicating the current program execution key (at the
time the EXEC CICS HANDLE AID command was issued).
- [USERS_RSA_POINTER]
- is the address of the user program Register Save Area into which the
program’s registers are saved at each EXEC CICS command execution.
- [AMODE]
- is the addressing mode (24-bit or 31-bit) of the program
at the time the handle command was driven.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The INQ_AID function of the PGHM gate is invoked when an aid has occurred,
and returns to the caller details of the handle aid for user EXEC CICS HANDLE
AID commands.
Input parameters
- AID
- is an 8-bit value identifying the aid.
Output parameters
- [LABEL]
- is the token identifying the condition label within the program to be
branched to if the aid occurs.
- [LANGUAGE]
- is the program language. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI
- [CURRENT_EXECUTION_KEY]
- is an 8-bit value indicating the current program execution key (at the
time the EXEC CICS HANDLE AID command was issued).
- [USERS_RSA_POINTER]
- is the address of the user program Register Save Area into which the
program’s registers are saved at each EXEC CICS command execution.
- [PROGRAM_MASK]
- identifies the program mask at the time the HANDLE CONDITION command
was executed.
- [GOTOL]
- is the token identifying the condition label within the program to be
branched to if the condition is ignored.
- [STATUS]
- identifies the status of the AID. It can have either of these values:
SYSTEM_DEFAULT|HANDLED
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The SET_ABEND function of the PGHM gate is invoked in response to a user
EXEC CICS HANDLE ABEND command, and saves the details of the handle into the
current abend Handle Table.
Input parameters
- OPERATION
- identifies what is to be done if the abend occurs. It can have any of
these values:
HANDLE|CANCEL|RESET
Note:
Specify either
the LABEL parameter or the PROGRAM parameter, not both.
- [LABEL]
- is the token identifying the condition label within the program to be
branched to if the abend occurs.
- [PROGRAM]
- is the name of the program to which control will be passed if the abend
occurs.
- [LANGUAGE]
- is the program language. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI
- [CURRENT_EXECUTION_KEY]
- is an 8-bit value indicating the current program execution key (at the
time the EXEC CICS HANDLE ABEND command was issued).
- [USERS_RSA_POINTER]
- is the address of the user program Register Save Area into which the
program’s registers are saved at each EXEC CICS command execution.
- [AMODE]
- is the addressing mode (24-bit or 31-bit) of the program
at the time the handle command was driven.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The INQ_ABEND function of the PGHM gate is invoked when an abend has occurred,
and returns to the caller details of the handle abend for user EXEC CICS HANDLE
AID commands.
Input parameters
None.
Output parameters
- STATUS
- identifies the status of the condition. It can have either of these
values:
SYSTEM_DEFAULT|HANDLED
- [LABEL]
- is the token identifying the condition label within the program branched
to when the abend occurred.
- [PROGRAM]
- is the name of the program to which control was passed when the abend
occurred.
- [LANGUAGE]
- is the program language. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI
- [CURRENT_EXECUTION_KEY]
- is an 8-bit value indicating the current program execution key (at the
time the EXEC CICS HANDLE AID command was issued).
- [USERS_RSA_POINTER]
- is the address of the user program Register Save Area into which the
program’s registers are saved at each EXEC CICS command execution.
- [PROGRAM_MASK]
- identifies the program mask at the time the HANDLE CONDITION command
was executed.
- [GOTOL]
- is the token identifying the condition label within the program to be
branched to if the condition is ignored.
- [HANDLE_COUNT]
- is the number of times that this abend code has been handled.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The PUSH_HANDLE function of the PGHM gate is invoked for a user EXEC CICS
PUSH command.
Input parameters
None.
Output parameters
- [FASTPATH_FLAGS]
- identifies the fastpath flag settings for the conditions.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The POP_HANDLE function of the PGHM gate is invoked for a user EXEC CICS
POP command.
Input parameters
None.
Output parameters
- [FASTPATH_FLAGS]
- identifies the fastpath flag settings for the conditions.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
NO_PREVIOUS_PUSH |
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The FREE_HANDLE_TABLES function of the PGHM gate is invoked by CICS during
program termination processing and frees all storage relating to the Handle
State for that program level.
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The CLEAR_LABELS function of the PGHM gate is invoked by CICS during XCTL
processing and frees all storage relating to the Handle State for that program
(except for the initial default state) and removes all user-defined label
handles.
Input parameters
None.
Output parameters
- [FASTPATH_FLAGS]
- identifies the fastpath flag settings for the conditions.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
MISSING_PARAMETER
|
The INQUIRE_PROGRAM function of the PGIS gate is used to inquire about
attributes of a program.
Input parameters
Note:
Specify either the PROGRAM_NAME parameter or the PROGRAM_TOKEN
parameter, not both.
- PROGRAM_NAME
- is the name of the program.
- PROGRAM_TOKEN
- is the token identifying the program.
Output parameters
- [CEDF_STATUS]
- indicates whether or not the EDF diagnostic screens are displayed when
the program is running under the control of the execution diagnostic facility
(EDF) It can have any of these values:
CEDF|NOCEDF|NOT_APPLIC
- [HOLD_STATUS]
- is the hold status of the program (that is, for how long the program
is to be loaded). It can have any of these values:
TASK_LIFE|CICS_LIFE|NOT_APPLIC
- [LOAD_STATUS]
- is the load status of the program (that is, whether or not the program
can be loaded). It can have any of these values:
LOADABLE|NOT_LOADABLE|NOT_LOADED|NOT_APPLIC
- [INSTALL_TYPE]
- is the method used to install the PROGRAM resource definition. It can
have any of these values:
RDO|CATALOG|GROUPLIST|AUTO|SYSAUTO|MANUAL
- [LANGUAGE_DEFINED]
- is the language defined for the program. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI|
NOT_DEFINED|NOT_APPLIC
- [LANGUAGE_DEDUCED]
- is the language deduced by CICS for the program. It can have any of
these values:
ASSEMBLER|C370|COBOL|COBOL2|JAVA|LE370|PLI|
NOT_DEDUCED|NOT_APPLIC
- [AVAIL_STATUS]
- defines whether (ENABLED) or not (DISABLED) the program can be used.
It can have either of these values:
ENABLED|DISABLED
- [MODULE_TYPE]
- is the type of program resource to be defined: It can have any of these
values:
PROGRAM|MAPSET|PARTITIONSET
- [DATA_LOCATION]
- defines whether the program can handle only 24-bit addresses (data located
below the 16MB line) can handle 31-bit addresses (data located above or below
the 16MB line). The DATALOCATION options are independent from the addressing
mode of the link-edited program. It can have either of these values:
ANY|BELOW|NOT_APPLIC
- [EXECUTION_SET]
- indicates whether you want CICS to 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). It can have either of these values:
FULLAPI|DPLSUBSET|NOT_APPLIC
- [REMOTE_PROGID]
- is 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]
- is the name of a remote CICS region if you want CICS to ship a distributed
program link (DPL) request to another CICS region.
- [REMOTE_TRANID]
- is the name of the transaction you want the remote CICS to attach, and
under which it is to run the remote program.
- [EXECUTION_KEY]
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER|NOT_APPLIC
Note:
If the program is
link-edited with the RENT attribute and the RMODE(ANY) mode statement, CICS
loads the program into extended the 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.
- [PROGRAM_TYPE]
- is the type of program. It can have any of these values:
PRIVATE|SHARED|TYPE_ANY|NOT_APPLIC
- [PROGRAM_USAGE]
- defines whether the program is to be used as a CICS nucleus program
or as a user application program. It can have either of these values:
NUCLEUS|APPLICATION
- [PROGRAM_ATTRIBUTE]
- defines the residence status of the program, and when the storage for
this program is released. It can have any of these values:
RESIDENT|REUSABLE|TRANSIENT|RELOAD|TEST
- [SPECIFIED_AMODE]
- is the addressing mode of the program. It can have any of these values:
24|31|AMODE_ANY|AMODE_NOT_SPECIFIED
- [SPECIFIED_RMODE]
- is the residence mode of the program. It can have any of these values:
24|RMODE_ANY|RMODE_NOT_SPECIFIED
- [PROGRAM_LENGTH]
- is the length of the program. returned by the loader domain on the ACQUIRE_PROGRAM
call.
- [PROGRAM_USE_COUNT]
- is the number of times that the program has been used.
- [PROGRAM_USER_COUNT]
- is the number of different users that have invoked the program.
- [LOAD_POINT]
- is the load point address of the program returned by the loader domain
on the ACQUIRE_PROGRAM call.
- [ENTRY_POINT]
- is the entry point address of the program returned by the loader domain
on the ACQUIRE_PROGRAM call.
- [LOCATION]
- defines where the program resides. It can have any of these values:
CDSA|ECDSA|SDSA|ESDSA|RDSA|ERDSA|LPA|ELPA|NONE
- [ACCESS]
- is the type of access for the program. It can have any of these values:
USER|CICS|READ_ONLY|NONE
- [REMOTE_DEFINITION]
- indicates whether the program is defined as remote or local. It can
take the values:
REMOTE|LOCAL
- [NEW_PROGRAM_TOKEN]
- is the loader domain token for the program
- [DYNAMIC_STATUS]
- indicates whether or not a request to LINK to the program may be dynamically
routed. It can have either of these values:
DYNAMIC|NOTDYNAMIC
- [CONCURRENCY]
- indicates whether the program is threadsafe or only quasi-reentrant.
It can have either of these two values:
THREADSAFE|QUASIRENT
- [JVM]
- indicates whether or not the program is to be executed under the control
of a JVM (Java Virtual Machine). It can have either of these values:
YES|NO
- [JVM_CLASS]
- is the name of the main class in a Java program to be run under the
control of a JVM.
- [HOTPOOL]
- indicates whether or not the Java program object is to be run in a
preinitialized Language Environment enclave reused by multiple invocations
of the program, under control of an H8 TCB. It can have either of these two
values:
YES|NO
- [JVM_PROFILE]
- specifies the name of the JVM profile. The named profile provides the
attributes of the JVM that is needed to execute the program.
- [JVMPROGRAM_USE_COUNT]
- For Java programs to be run under the control of a JVM, the number of
times the program has been used.
- [RUNTIME_ENVIRONMENT]
- indicates the runtime environment used for the execution of this program.
It can take the values
JVM_RUNTIME|LE370_RUNTIME|NON_LE370_RUNTIME|
UNKNOWN_RUNTIME|NOT_APPLIC
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOCK_ERROR
|
EXCEPTION |
PROGRAM_NOT_DEFINED_TO_LD
PROGRAM_NOT_DEFINED_TO_PG
|
INVALID |
INVALID_PROGRAM_TOKEN |
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
None.
Output parameters
- [CEDF_STATUS]
- indicates whether or not the EDF diagnostic screens are displayed when
the program is running under the control of the execution diagnostic facility
(EDF) It can have any of these values:
CEDF|NOCEDF|NOT_APPLIC
- [HOLD_STATUS]
- is the hold status of the program (that is, for how long the program
is to be loaded). It can have any of these values:
TASK_LIFE|CICS_LIFE|NOT_APPLIC
- [LOAD_STATUS]
- is the load status of the program (that is, whether or not the program
can be loaded). It can have any of these values:
LOADABLE|NOT_LOADABLE|NOT_LOADED|NOT_APPLIC
- [INSTALL_TYPE]
- is the method used to install the PROGRAM resource definition. It can
have any of these values:
RDO|CATALOG|GROUPLIST|AUTO|SYSAUTO|MANUAL
- [LANGUAGE_DEFINED]
- is the language defined for the program. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI|
NOT_DEFINED|NOT_APPLIC
- [LANGUAGE_DEDUCED]
- is the language deduced by CICS for the program. It can have any of
these values:
ASSEMBLER|C370|COBOL|COBOL2|LE370|PLI|
NOT_DEDUCED|NOT_APPLIC
- [AVAIL_STATUS]
- defines whether (ENABLED) or not (DISABLED) the program can be used.
It can have either of these values:
ENABLED|DISABLED
- [MODULE_TYPE]
- is the type of program resource to be defined: It can have any of these
values:
PROGRAM|MAPSET|PARTITIONSET
- [DATA_LOCATION]
- defines whether the program can handle only 24-bit addresses (data located
below the 16MB line) can handle 31-bit addresses (data located above or below
the 16MB line). The DATALOCATION options are independent from the addressing
mode of the link-edited program. It can have either of these values:
ANY|BELOW|NOT_APPLIC
- [EXECUTION_SET]
- indicates whether you want CICS to 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). It can have any of these values:
FULLAPI|DPLSUBSET|NOT_APPLIC
- [REMOTE_DEFINITION]
- defines whether the program is local or remote. It can have either of
these values:
LOCAL|REMOTE
- [REMOTE_PROGID]
- is 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]
- is the name of a remote CICS region if you want CICS to ship a distributed
program link (DPL) request to another CICS region.
- [REMOTE_TRANID]
- is the name of the transaction you want the remote CICS to attach, and
under which it is to run the remote program.
- [EXECUTION_KEY]
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have any of these
values:
CICS|USER|NOT_APPLIC
Note:
If the program is
link-edited with the RENT attribute and the RMODE(ANY) mode statement, CICS
loads the program into extended the 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.
- NEW_PROGRAM_TOKEN
- is the token assigned to program.
- [CURRENT_PROGRAM_NAME]
- is the current name of the program.
- [INVOKING_PROGRAM_NAME]
- is the name of the program invoking this program.
- [RETURN_PROGRAM_NAME]
- is the name of the program to which control will be returned when this
program has ended.
- [CURRENT_CEDF_STATUS]
- indicates whether or not the EDF diagnostic screens are displayed when
the program is running under the control of the execution diagnostic facility
(EDF) It can have either of these values:
CEDF|NOCEDF
- [CURRENT_EXECUTION_SET]
- indicates whether the program is running with or without the API restrictions
of a DPL program. It can have any of these values:
FULLAPI|DPLSUBSET
- [CURRENT_ENVIRONMENT]
- indicates the current environment in which the program is running. It
can have any of these values:
EXEC|GLUE|PLT|SYSTEM|TRUE|URM
- [CURRENT_AMODE]
- is the addressing mode of the program. It can have either of these values:
24|31
- [CURRENT_LOAD_POINT]
- is the current load point address of the program returned by the loader
domain on the ACQUIRE_PROGRAM call.
- [CURRENT_ENTRY_POINT]
- is the current entry point address of the program returned by the loader
domain on the ACQUIRE_PROGRAM call.
- [CURRENT_PROGRAM_LENGTH]
- is the length of the current program in bytes, as returned by the Loader
Domain on the AQUIRE_PROGRAM call.
- [INVOKING_ENVIRONMENT]
- is the environment in which the program invoking this program was executing.
It can have any of these values:
EXEC|GLUE|PLT|SYSTEM|TRUE|URM
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOCK_ERROR
|
EXCEPTION |
NO_CURRENT_PROGRAM |
The SET_PROGRAM function of the PGIS gate is used to set the characteristics
of a program when it is loaded.
Input parameters
note.Specify either the PROGRAM_NAME parameter or the PROGRAM_TOKEN parameter,
not both.
- PROGRAM_NAME
- is the name of the program.
- PROGRAM_TOKEN
- is the token identifying the program.
- [CEDF_STATUS]
- indicates whether or not the EDF diagnostic screens are displayed when
the program is running under the control of the execution diagnostic facility
(EDF) It can have either of these values:
CEDF|NOCEDF
- [AVAIL_STATUS]
- defines whether (ENABLED) or not (DISABLED) the program can be used.
It can have either of these values:
ENABLED|DISABLED
- [EXECUTION_SET]
- indicates whether you want CICS to 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). It can have either of these values:
FULLAPI|DPLSUBSET
- [EXECUTION_KEY]
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER
Note:
If the program is link-edited
with the RENT attribute and the RMODE(ANY) mode statement, CICS loads the
program into extended the 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.
- [PROGRAM_TYPE]
- is the type of program. It can have any of these values:
PRIVATE|SHARED|TYPE_ANY
- [PROGRAM_USAGE]
- defines whether the program is to be used as a CICS nucleus program
or as a user application program. It can have either of these values:
NUCLEUS|APPLICATION
- [PROGRAM_ATTRIBUTE]
- defines the residence status of the program, and when the storage for
this program is released. It can have any of these values:
RESIDENT|REUSABLE|TRANSIENT|RELOAD|TEST
- [REQUIRED_AMODE]
- is the addressing mode of the program. It can have any of these values:
24|31|AMODE_ANY
- [REQUIRED_RMODE]
- is the residence mode of the program. It can have any of these values:
24|RMODE_ANY
- [JVM]
- indicates whether or not the program is to be executed under the control
of a JVM (Java Virtual Machine). It can have either of these values:
YES|NO
- [JVM_CLASS]
- is the name of the main class in a Java program to be run under the
control of a JVM.
- [JVM_PROFILE]
- is the name of the JVM profile that provides the attributes of the JVM
which is needed to execute the program.
- [HOTPOOL]
- indicates whether or not the Java program object is to be run in a
preinitialized Language Environment enclave reused by multiple invocations
of the program, under control of an H8 TCB. It can have either of these two
values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
CATALOG_NOT_OPERATIONAL
CATALOG_ERROR
LOCK_ERROR
INSUFFICIENT_STORAGE
|
EXCEPTION |
PROGRAM_NOT_DEFINED_TO_PG
CEDF_STATUS_NOT_FOR_REMOTE
CEDF_STATUS_NOT_FOR_MAPSET
CEDF_STATUS_NOT_FOR_PTNSET
EXEC_SET_NOT_FOR_REMOTE
EXEC_SET_NOT_FOR_MAPSET
EXEC_SET_NOT_FOR_PTNSET
EXEC_KEY_NOT_FOR_REMOTE
EXEC_KEY_NOT_FOR_MAPSET
EXEC_KEY_NOT_FOR_PTNSET
PROG_TYPE_NOT_FOR_REMOTE
PROGRAM_NOT_DEFINED_TO_LD
PROGRAM_NOT_FOUND
JVM_BUT_NO_JVMCLASS
HOTPOOL_NOT_FOR_REMOTE
HOTPOOL_NOT_FOR_MAPSET
HOTPOOL_NOT_FOR_PTNSET
|
INVALID |
INVALID_MODE_COMBINATION
INVALID_PROGRAM_NAME
INVALID_PROGRAM_TOKEN
INVALID_TYPE_ATTRIB_COMBIN
|
The START_BROWSE_PROGRAM function of the PGIS gate is used to start browsing
through program definitions, optionally starting at the given program definition.
Input parameters
- [PROGRAM_NAME]
- is the optional name of the program definition at which you want to
start browsing.
- [TASK_RELATED]
- indicates whether or not the browse is task-related. If it is task-related,
storage will be obtained from the CICS storage class rather than the directory
browse subpool. The default is YES.
Output parameters
- BROWSE_TOKEN
- is a token identifying the program definition being browsed.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
INVALID_DIRECTORY
LOCK_ERROR
|
The GET_NEXT_PROGRAM function of the PGIS gate is used to get the next
program definition to be browse.
Input parameters
- BROWSE_TOKEN
- is a token identifying the program definition to be browsed.
Output parameters
- [CEDF_STATUS]
- indicates whether or not the EDF diagnostic screens are displayed when
the program is running under the control of the execution diagnostic facility
(EDF) It can have any of these values:
CEDF|NOCEDF|NOT_APPLIC
- [HOLD_STATUS]
- is the hold status of the program (that is, for how long the program
is to be loaded). It can have any of these values:
TASK_LIFE|CICS_LIFE|NOT_APPLIC
- [LOAD_STATUS]
- is the load status of the program (that is, whether or not the program
can be loaded). It can have any of these values:
LOADABLE|NOT_LOADABLE|NOT_LOADED|NOT_APPLIC
- [INSTALL_TYPE]
- is the method used to install the PROGRAM resource definition. It can
have any of these values:
RDO|CATALOG|GROUPLIST|AUTO|SYSAUTO|MANUAL
- [LANGUAGE_DEFINED]
- is the language defined for the program. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI|
NOT_DEFINED|NOT_APPLIC
- [LANGUAGE_DEDUCED]
- is the language deduced by CICS for the program. It can have any of
these values:
ASSEMBLER|C370|COBOL|COBOL2|LE370|PLI|
NOT_DEDUCED|NOT_APPLIC
- [AVAIL_STATUS]
- defines whether (ENABLED) or not (DISABLED) the program can be used.
It can have either of these values:
ENABLED|DISABLED
- [MODULE_TYPE]
- is the type of program resource to be defined: It can have any of these
values:
PROGRAM|MAPSET|PARTITIONSET
- [DATA_LOCATION]
- defines whether the program can handle only 24-bit addresses (data located
below the 16MB line) can handle 31-bit addresses (data located above or below
the 16MB line). The DATALOCATION options are independent from the addressing
mode of the link-edited program. It can have either of these values:
ANY|BELOW|NOT_APPLIC
- [EXECUTION_SET]
- indicates whether you want CICS to 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). It can have either of these values:
FULLAPI|DPLSUBSET|NOT_APPLIC
- [REMOTE_PROGID]
- is 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]
- is the name of a remote CICS region if you want CICS to ship a distributed
program link (DPL) request to another CICS region.
- [REMOTE_TRANID]
- is the name of the transaction you want the remote CICS to attach, and
under which it is to run the remote program.
- [EXECUTION_KEY]
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER|NOT_APPLIC
Note:
If the program is
link-edited with the RENT attribute and the RMODE(ANY) mode statement, CICS
loads the program into extended the 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.
- [PROGRAM_TYPE]
- is the type of program. It can have any of these values:
PRIVATE|SHARED|TYPE_ANY|NOT_APPLIC
- [PROGRAM_USAGE]
- defines whether the program is to be used as a CICS nucleus program
or as a user application program. It can have either of these values:
NUCLEUS|APPLICATION
- [PROGRAM_ATTRIBUTE]
- defines the residence status of the program, and when the storage for
this program is released. It can have any of these values:
RESIDENT|REUSABLE|TRANSIENT|RELOAD|TEST
- [SPECIFIED_AMODE]
- is the addressing mode of the program. It can have any of these values:
24|31|AMODE_ANY|AMODE_NOT_SPECIFIED
- [SPECIFIED_RMODE]
- is the residence mode of the program. It can have any of these values:
24|RMODE_ANY|RMODE_NOT_SPECIFIED
- [PROGRAM_LENGTH]
- is the length of the program. returned by the loader domain on the ACQUIRE_PROGRAM
call.
- [PROGRAM_USE_COUNT]
- is the number of times that the program has been used.
- [PROGRAM_USER_COUNT]
- is the number of different users that have invoked the program.
- [LOAD_POINT]
- is the load point address of the program returned by the loader domain
on the ACQUIRE_PROGRAM call.
- [ENTRY_POINT]
- is the entry point address of the program returned by the loader domain
on the ACQUIRE_PROGRAM call.
- [LOCATION]
- defines where the program resides. It can have any of these values:
CDSA|ECDSA|SDSA|ESDSA|RDSA|ERDSA|LPA|ELPA|NONE
- [ACCESS
- is the type of access for the program. It can have any of these values:
USER|CICS|READ_ONLY|NONE
- [REMOTE_DEFINITION]
- indicates whether the program is defined as remote or local. It can
take the values:
REMOTE|LOCAL
- [NEW_PROGRAM_TOKEN]
- is the loader domain token for the program
- [DYNAMIC_STATUS]
- indicates whether or not a request to LINK to the program may be dynamically
routed. It can have either of these values:
DYNAMIC|NOTDYNAMIC
- [CONCURRENCY]
- indicates whether the program is threadsafe or only quasi-reentrant.
It can have either of these two values:
THREADSAFE|QUASIRENT
- [JVM]
- indicates whether or not the program is to be executed under the control
of a JVM (Java Virtual Machine). It can have either of these values:
YES|NO
- [JVM_CLASS]
- is the name of the main class in a Java program to be run under the
control of a JVM.
- [HOTPOOL]
- indicates whether or not the Java program object is to be run in a
preinitialized Language Environment enclave reused by multiple invocations
of the program, under control of an H8 TCB. It can have either of these two
values:
YES|NO
- [JVM_PROFILE]
- specifies the name of the data set member that contains the JVM profile..
The named profile provides the attributes of the JVM that is needed to execute
the program.
- [RUNTIME_ENVIRONMENT]
- indicates the runtime environment used for the execution of this program.
It can take the values
JVM_RUNTIME|LE370_RUNTIME|NON_LE370_RUNTIME|
UNKNOWN_RUNTIME|NOT_APPLIC
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOCK_ERROR
|
EXCEPTION |
INVALID_BROWSE_TOKEN
END_LIST
PROGRAM_NOT_DEFINED_TO_LD
|
The END_BROWSE_PROGRAM function of the PGIS gate is used to end browsing
through program definitions.
Input parameters
- BROWSE_TOKEN
- is a token identifying the last program definition that was browsed.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOCK_ERROR
|
EXCEPTION |
INVALID_BROWSE_TOKEN
END_LIST
|
The REFRESH_PROGRAM function of the PGIS gate is used to inform the loader
domain that a new copy of a named program is now available for use in the
relocatable program library.
Input parameters
- PROGRAM_NAME
- is the name of the program being refreshed.
- COPY
- indicates whether a NEWCOPY or PHASEIN function is required.
Output parameters
- VERSION
- is the version of the program after the REFRESH_PROGRAM function call.
It can have either of these values:
NEW|OLD
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOCK_ERROR
|
EXCEPTION |
PROGRAM_LOADED_CICS_LIFE
PROGRAM_NOT_DEFINED_TO_LD
PROGRAM_NOT_DEFINED_TO_PG
PROGRAM_NOT_FOUND
REMOTE_PROGRAM
PROGRAM_IN_USE
|
The LOAD_EXEC function of the PGLD gate is used to load a program in response
to an EXEC CICS LOAD command.
Input parameters
- PROGRAM_NAME
- is the name of the program being refreshed.
- 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). It can have either of these
values:
CICS_LIFE|TASK_LIFE|CALLER_MANAGED
Output parameters
- LOAD_POINT
- is the current load point address of the program returned by the loader
domain on the ACQUIRE_PROGRAM call.
- ENTRY_POINT
- is the current entry 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.
- [LANGUAGE_TOKEN]
- is a token representing the AP domain language block for the program.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
REMOTE_PROGRAM
NOT_AUTHORIZED
AUTOINSTALL_URM_FAILED
AUTOINSTALL_INVALID_DATA
AUTOINSTALL_MODEL_NOT_DEF
AUTOINSTALL_FAILED
NOT_INITIALIZED
JVM_PROGRAM
|
INVALID |
INVALID_FUNCTION |
The LOAD function of the PGLD gate is used to load a program in response
to a CICS internal load request.
Input parameters
- PROGRAM_NAME
- is the name of the program being refreshed.
- 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). It can have either of these
values:
CICS_LIFE|TASK_LIFE
- MODULE_TYPE
- is the type of program to be loaded: It can have any of these values:
PROGRAM|MAPSET|PARTITIONSET
- SYSTEM_AUTOINSTALL
- defines whether CICS is to autoinstall the program if there is no associated
PROGRAM resource definition. It can have either of these values:
YES|NO
- [LPA_ELIGIBLE]
- defines whether or not the program can be loaded into the MVS link pack
area (LPA). It can have either of these values:
YES|NO
- [SUSPEND]
- 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.
Output parameters
- LOAD_POINT
- is the current load point address of the program returned by the loader
domain on the ACQUIRE_PROGRAM call.
- ENTRY_POINT
- is the current entry 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
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
REMOTE_PROGRAM
AUTOINSTALL_URM_FAILED
AUTOINSTALL_INVALID_DATA
AUTOINSTALL_MODEL_NOT_DEF
AUTOINSTALL_FAILED
JVM_PROGRAM
|
INVALID |
INVALID_FUNCTION |
The RELEASE_EXEC function of the PGLD gate is used to release a program
in response to an EXEC CICS RELEASE command.
Input parameters
- PROGRAM_NAME
- is the name of the program being released.
- [ENTRY_POINT]
- must be provided on RELEASE_EXEC by the caller for a program loaded
with caller-managed lifetime.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_AUTHORIZED
NOT_INITIALIZED
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_IN_USE
PROGRAM_NOT_LOADED
PROGRAM_RELOAD_YES
RELEASE_ISSUING_PROGRAM
REMOTE_PROGRAM
JVM_PROGRAM
|
INVALID |
INVALID_FUNCTION |
The RELEASE function of the PGLD gate is used by CICS internal modules
to release a program in response previously loaded by a PGLD LOAD request.
Input parameters
- PROGRAM_NAME
- is the name of the program being released.
- [ENTRY_POINT]
- must be provided on RELEASE_EXEC by the caller for a program loaded
with caller-managed lifetime.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_IN_USE
PROGRAM_NOT_LOADED
PROGRAM_RELOAD_YES
REMOTE_PROGRAM
JVM_PROGRAM
|
INVALID |
INVALID_FUNCTION |
The LINK_EXEC function of the PGLE gate is used to link to a program in
response to a user EXEC CICS LINK command.
Input parameters
- PROGRAM_NAME
- is the name of the program to be linked.
- [COMMAREA]
- is the optional communications area to be made available to the linked
program.
- [HANDLE_ABEND_PGM]
- defines whether or not the program is to run as an abend handler program.
It can have either of these values:
YES|NO
- [INPUTMSG]
- is a data area to be supplied to the linked program on its first execution
of an EXEC CICS RECEIVE command.
- [SYNCONRETURN]
- defines whether or not a syncpoint is to be taken on return from the
linked program. It can have either of these values:
YES|NO
- [SYSEIB_REQUEST]
- Specifies whether the EXEC CICS LINK had the SYSEIB translator option
specified.
- [FORCE_LOCAL]
- indicates whether the program must execute locally.
Output parameters
- [REMOTE_PROGRAM_NAME]
- is 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]
- is the name of a remote CICS region if you want CICS to ship a distributed
program link (DPL) request to another CICS region.
- [REMOTE_TRANID]
- is the name of the transaction you want the remote CICS to attach, and
under which it is to run the remote program.
- [ABEND_CODE]
- is the four-character abend code to be issued if there is an exception
response with reason TRANSACTION_ABEND.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
AUTOINSTALL_FAILED
AUTOINSTALL_INVALID_DATA
AUTOINSTALL_MODEL_NOT_DEF
AUTOINSTALL_URM_FAILED
DESTRUCTIVE_OVERLAP
INVALID_COMMAREA_ADDR
INVALID_COMMAREA_LEN
INVALID_INPUTMSG_LEN
INVALID_TERMINAL_TYPE
NOT_INITIALIZED
PROGRAM_NOT_AUTHORIZED
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
REMOTE_PROGRAM
TRANSACTION_ABEND
DYNAMIC_PGM
SECOND_JVM_PROGRAM
SECOND_H8_PROGRAM
JVMPOOL_DISABLED
JVM_PROFILE_NOT_FOUND
JVM_PROFILE_NOT_VALID
SYSTEM_PROPERTIES_NOT_FND
USER_CLASS_NOT_FOUND
|
The LINK function of the PGLK gate is used by CICS internal modules to
link to a program.
Input parameters
- PROGRAM_NAME
- is the name of the program being linked.
- SYSTEM_AUTOINSTALL
- defines whether CICS is to autoinstall the program if there is no associated
PROGRAM resource definition. It can have either of these values:
YES|NO
- [LPA_ELIGIBLE]
- defines whether or not the program can be loaded into the MVS link pack
area (LPA). It can have either of these values:
YES|NO
- [PARMLIST_PTR]
- is the address of a parameter list passed by the CICS program initiating
the PGLK link to the new program.
Output parameters
- [ABEND_CODE]
- is the four-character abend code to be issued if there is an exception
response with reason TRANSACTION_ABEND.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
REMOTE_PROGRAM
AUTOINSTALL_URM_FAILED
AUTOINSTALL_MODEL_NOT_DEF
AUTOINSTALL_INVALID_DATA
AUTOINSTALL_FAILED
TRANSACTION_ABEND
|
INVALID |
INVALID_FUNCTION |
The LINK_PLT function of the PGLK gate is used by CICS internal modules
to link to a program in the program list table.
Input parameters
- PROGRAM_NAME
- is the name of the program being linked.
- SYSTEM_AUTOINSTALL
- defines whether CICS is to autoinstall the program if there is no associated
PROGRAM resource definition. It can have either of these values:
YES|NO
- [LPA_ELIGIBLE]
- defines whether or not the program can be loaded into the MVS link pack
area (LPA). It can have either of these values:
YES|NO
Output parameters
- [ABEND_CODE]
- is the four-character abend code to be issued if there is an exception
response with reason TRANSACTION_ABEND.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
REMOTE_PROGRAM
AUTOINSTALL_URM_FAILED
AUTOINSTALL_MODEL_NOT_DEF
AUTOINSTALL_INVALID_DATA
AUTOINSTALL_FAILED
TRANSACTION_ABEND
|
INVALID |
INVALID_FUNCTION |
The LINK_URM function of the PGLU gate is used by CICS internal modules
to link to a user-replaceable program.
Input parameters
- PROGRAM_NAME
- is the name of the program to be linked.
- SYSTEM_AUTOINSTALL
- defines whether CICS is to autoinstall the program if there is no associated
PROGRAM resource definition. It can have either of these values:
YES|NO
- [LPA_ELIGIBLE]
- defines whether or not the program can be loaded into the MVS link pack
area (LPA). It can have either of these values:
YES|NO
- [COMMAREA]
- is the optional communications area to be made available to the linked
program.
- [CALLER_THREADSAFE]
- indicates that the caller of the user-replaceable program is threadsafe,
and so execution can continue on any TCB on return from the program: there
is no need for PGLU to issue change_mode.
Output parameters
- [ABEND_CODE]
- is the four-character abend code to be issued if there is an exception
response with reason URM_ABEND.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
REMOTE_PROGRAM
AUTOINSTALL_URM_FAILED
AUTOINSTALL_MODEL_NOT_DEF
AUTOINSTALL_INVALID_DATA AUTOINSTALL_FAILED
INVALID_COMMAREA_LEN
INVALID_COMMAREA_ADDR
AMODE_ERROR
URM_ABEND
DESTRUCTIVE_OVERLAP
SECOND_JVM_PROGRAM
SECOND_H8_PROGRAM
JVMPOOL_DISABLED
JVM_PROFILE_NOT_FOUND
JVM_PROFILE_NOT_VALID
SYSTEM_PROPERTIES_NOT_FND
USER_CLASS_NOT_FOUND
|
INVALID |
INVALID_FUNCTION |
The INITIAL_LINK function of the PGPG gate is used to link to the first
program of a transaction.
Input parameters
- PROGRAM_NAME
- is the name of the program being linked.
Output parameters
- [ABEND_CODE]
- is the four-character abend code to be issued if there is an exception
response with reason TRANSACTION_ABEND.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
AUTOINSTALL_FAILED
AUTOINSTALL_INVALID_DATA
AUTOINSTALL_MODEL_NOT_DEF
AUTOINSTALL_URM_FAILED
DESTRUCTIVE_OVERLAP
INVALID_TERMINAL_TYPE
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
PROGRAM_NOT_DEFINED
REMOTE_PROGRAM
TRANSACTION_ABEND
SECOND_JVM_PROGRAM
SECOND_H8_PROGRAM
JVMPOOL_DISABLED
JVM_PROFILE_NOT_FOUND
JVM_PROFILE_NOT_VALID
SYSTEM_PROPERTIES_NOT_FND
USER_CLASS_NOT_FOUND
|
The PREPARE_RETURN_EXEC function of the PGRE gate is used to process the
communications area, inputmsg data, and transaction identifier from a user
EXEC CICS RETURN command.
Input parameters
- [TRANSID]
- is the four-character transaction identifier.
- [COMMAREA]
- is the optional communications area made available to the linked program.
- [INPUTMSG]
- is a data area to be supplied to the linked program on its first execution
of an EXEC CICS RECEIVE command.
- [IMMEDIATE]
- Indicates whether or not the transaction specified in TRANSID is to
be attached as the next transaction regardless of any other transactions enqueued
by ATI for this terminal. It can have either of these values:
YES|NO
- [ENDACTIVITY]
- indicates that a BTS activity is to be ended.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_COMMAREA_ADDR
INVALID_COMMAREA_LEN
INVALID_INPUTMSG_LEN
INVALID_TERMINAL_TYPE
INVALID_REQUEST_FROM_EXIT
INVALID_RETURN_REQUEST
NOT_INITIALIZED
NO_TERMINAL
TRANSID_NO_TERMINAL
|
The PREPARE_XCTL_EXEC function of the PGXE gate is used to process the
communications area, inputmsg data, and transaction identifier from a user
EXEC CICS XCTL command.
Input parameters
- PROGRAM_NAME
- is the name of the program to which control is to be passed.
- [COMMAREA]
- is the optional communications area made available to the linked program.
- [INPUTMSG]
- is a data area to be supplied to the linked program on its first execution
of an EXEC CICS RECEIVE command.
- [SYSEIB_REQUEST]
- specifies whether the EXEC CICS LINK had the SYSEIB translator option
specified.
- [SECURITY]
- indicates whether Program Manager must check security authorisation
for the target program
Output parameters
- [ABEND_CODE]
- is the four-character abend code to be issued if CICS drives the system
default, which is to abend the transaction.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
AUTOINSTALL_FAILED
AUTOINSTALL_INVALID_DATA
AUTOINSTALL_MODEL_NOT_DEF
AUTOINSTALL_URM_FAILED
DESTRUCTIVE_OVERLAP
INVALID_COMMAREA_ADDR
INVALID_COMMAREA_LEN
INVALID_INPUTMSG_LEN
INVALID_TERMINAL_TYPE
INVALID_REQUEST_FROM_EXIT
NOT_INITIALIZED
PROGRAM_NOT_AUTHORIZED
PROGRAM_NOT_DEFINED
PROGRAM_NOT_ENABLED
PROGRAM_NOT_LOADABLE
REMOTE_PROGRAM
TRANSACTION_ABEND
|
The INITIALIZE_TRANSACTION function of the PGXM gate is used to initialize
a transaction, and set up storage for the transaction.
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FUNCTION |
The TERMINATE_TRANSACTION function of the PGXM gate is used to terminate
a transaction, and clean up the transaction-related storage at task termination.
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FUNCTION |
[[ Contents Previous Page | Next Page Index ]]