PGCR gate, GET_CONTAINER_LENGTH function
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
- Optional Parameter
- is the call part of an API call.
- Values for the parameter are:
- EXEC
- SYSTEM
- CCSID
- Optional Parameter
- is the default coded character set identifier (CCSID) for character data in this channel.
- CONTAINER_NAME
- Optional Parameter
- is the name of the container to be copied.
- CONTAINER_TOKEN
- Optional Parameter
- is a token referencing the container to be copied.
- POOL_TOKEN
- Optional Parameter
- is 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 to user programs as well.
- Values for the parameter are:
- 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
- is the coded character set identifier of the extracted data.
- 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