S2AD gate, ADD_SUBPOOL function

The ADD_SUBPOOL function of the S2AD gate is used to create a new subpool with given attributes.

Input Parameters

BOUNDARY
The boundary on which all elements within the subpool must be aligned. The boundary must be a power of two, in the range 8 through 4096.
ELEMENT_CHAIN
Indicates whether a chain of the addresses and lengths of the elements is kept.
Values for the parameter are as follows:
  • NO
  • YES
ELEMENT_TYPE
Indicates whether the subpool elements are of fixed or variable length.
Values for the parameter are as follows:
  • FIXED
  • VARIABLE
INITIAL_FREE
The size of the initial free storage area for the subpool.
LOCATION
Specifies whether all elements within the subpool are private or shared.
Values for the parameter are as follows:
  • PRIVATE
  • SHARED
SUBPOOL_NAME
The 8-character name by which the subpool is known.
USAGE
Indicates whether the subpool is for task or domain use.
Values for the parameter are as follows:
  • DOMAIN
  • TASK
ACCESS
Optional Parameter
The type of storage access required.
Values for the parameter are as follows:
  • CICS
  • USER
FIXED_LENGTH
Optional Parameter
The element length for a fixed-length subpool.
LOCK_POOL
Optional Parameter
Indicates whether access to the subpool is controlled by a lock.
Values for the parameter are:
  • NO
  • YES
STORAGE_CHECK
Optional Parameter
Indicates whether storage zone checking is enabled for this subpool.
Values for the parameter are as follows:
  • NO
  • YES

Output Parameters

REASON
The following values are returned when RESPONSE is EXCEPTION:
  • INSUFFICIENT_STORAGE
The following values are returned when RESPONSE is INVALID:
  • DUPLICATE_SUBPOOL_NAME
  • INVALID_FIXED_LENGTH
  • INVALID_INITIAL_FREE
  • INVALID_SUBPOOL_NAME
  • LOCK_FAILED
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
SUBPOOL_TOKEN
The token that identifies the newly created subpool.
DSA_NAME
Optional Parameter
The name of the CICS® dynamic storage area (DSA) in which the subpool resides.
Values for the parameter are as follows:
  • GCDSA


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