PGCR gate, GET_CONTAINER_INTO function
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 name and type of the container. Note that LENGTH_ERROR indicates that as much data as possible has been copied.
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
- DATA_TOKEN_IN
- Optional Parameter
- A token that references 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 does not have a DATA_TOKEN_IN.
- ITEM_BUFFER
- Optional Parameter
- 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.
- ITEM_BUFFER64
- Optional Parameter
- On input, ITEM_BUFFER64_P is a 64-bit pointer to a receiving area of length ITEM_BUFFER_M. On output, the value ITEM_BUFFER64_N is set to the actual length returned.
- 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
- INVALID_DATA_TOKEN_IN
- LENGTH_ERROR
- MORE_DATA
- 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.
- DATA_TOKEN_OUT
- Optional Parameter
A token that references 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 does not have a DATA_TOKEN_IN.
- 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.
- USERACCESS
- Optional Parameter
- Whether USER containers can be updated by API commands.
- Values for the parameter are as follows:
- ANY
- READONLY