PGCR gate, GET_CONTAINER_SET function

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 the name and type of the container.

Input Parameters

CALLER
Optional Parameter
The call part of an API call.
Values for the parameter are as follows:
  • EXEC
  • SYSTEM
CCSID
Optional Parameter
The default coded character set identifier (CCSID) for character data in this channel.
CONTAINER_NAME
Optional Parameter
The name of the container to be copied.
CONTAINER_TOKEN
Optional Parameter
A token that references the container to be copied.
CONVERT
Optional Parameter
Whether the data in the container is converted.
Values for the parameter are as follows:
  • NO
  • YES
POOL_TOKEN
Optional Parameter
A token (returned on a CREATE_CONTAINER_POOL request) that identifies the container pool to be copied.
TYPE
Optional Parameter
Whether the container is visible only to CICS, or also to user programs.
Values for the parameter are as follows:
  • CICS
  • USER

Output Parameters

REASON
The following values are returned when RESPONSE is EXCEPTION:
  • CCSID_CONVERSION_ERROR
  • CCSID_IGNORED
  • CCSID_INVALID
  • CCSID_PAIR_UNSUPPORTED
  • CCSID_PARTIAL_CONVERSION
  • CONTAINER_NOT_FOUND
The following values are returned when RESPONSE is INVALID:
  • INVALID_CONTAINER_TOKEN
  • INVALID_PARAMETERS
  • INVALID_POOL_TOKEN
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
CONTAINER_CCSID
Optional Parameter
The coded character set identifier of the extracted data.
DATATYPE
Optional Parameter
The format of the data.
Values for the parameter are as follows:
  • BIT
  • CHAR
GENERATION_NUMBER
Optional Parameter
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
Optional Parameter
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
Optional Parameter
The address and length of the SET storage returned.
ITEM_DATA64
Optional Parameter
The 64-bit address and length of the SET storage returned.
USERACCESS
Optional Parameter
whether USER containers can be updated by API commands.
Values for the parameter are as follows:
  • ANY
  • READONLY


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