PGCR gate, INQUIRE_CONTAINER_BY_TOKEN function

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 copied.

Output Parameters

REASON
The following values are returned when RESPONSE is EXCEPTION:
  • CONTAINER_NOT_FOUND
The following values are returned when RESPONSE is INVALID:
  • INVALID_CONTAINER_TOKEN
  • INVALID_PARAMETERS
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
CCSID
Optional Parameter
is the default coded character set identifier (CCSID) for character data in the named channel.
CONTAINER_NAME
Optional Parameter
is the name of the container.
DATA_LENGTH
Optional Parameter
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
Optional Parameter
is the format of the data.
Values for the parameter are:
  • 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.
TYPE
Optional Parameter
whether the container is visible only to CICS, or to user programs as well.
Values for the parameter are:
  • CICS
  • USER
USERACCESS
Optional Parameter
whether USER containers can be updated by API commands.
Values for the parameter are:
  • ANY
  • READONLY


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