PGCR gate, PUT_CONTAINER function
The PUT_CONTAINER function of the PGCR gate is used to put data into a container from an area provided by the caller.
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 to convert the data in the container.
- Values for the parameter are as follows:
- NO
- YES (default)
- DATATYPE
- Optional Parameter
- The format of the data.
- Values for the parameter are as follows:
- BIT
- CHAR
- ITEM_DATA
- Optional Parameter
- The address and length of the put data.
- ITEM_DATA64
- Optional Parameter
- The 64-bit address and length of the put data.
- POOL_TOKEN
- Optional Parameter
- A token (returned on a CREATE_CONTAINER_POOL request) that identifies the container pool to be copied.
- PUT_TYPE
- Optional Parameter
- Whether the PUT data is appended to the current contents of the container, or replaces the current contents.
- Values for the parameter are as follows:
- APPEND
- REPLACE
- 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
- USERACCESS
- Optional Parameter
- Whether USER containers can be updated by API commands.
- Values for the parameter are as follows:
- ANY
- READONLY
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- CCSID_INVALID
- DATATYPE_CHANGE
- INVALID_CONTAINER_NAME
- LENGTH_ERROR
- READONLY_CONTAINER
- 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_TOKEN_OUT
- Optional Parameter
- A token that represents the new copy of the container.
- 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.