PGCR gate, INQUIRE_CONTAINER function

The INQUIRE_CONTAINER function of the PGCR gate is used to retrieve the attributes of a container.

Input Parameters

CONTAINER_NAME
is the name of the container to be copied.
POOL_TOKEN
is a token (returned on a CREATE_CONTAINER_POOL request) that identifies the container pool to be copied.
CALLER
Optional Parameter
is the call part of an API call.
Values for the parameter are:
  • EXEC
  • SYSTEM
TYPE
Optional Parameter
whether the container is visible only to CICS, or to user programs as well.
Values for the parameter are:
  • CICS
  • USER

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
  • INVALID_POOL_TOKEN
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_TOKEN
Optional Parameter
is a token referencing 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.
USERACCESS
Optional Parameter
whether USER containers can be updated by API commands.
Values for the parameter are:
  • ANY
  • READONLY


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