S2GF gate, FREEMAIN function
The FREEMAIN function of the S2GF gate is used to release an element of storage within a subpool.
Input Parameters
- ADDRESS
- The 64-bit address of the element to release.
- SUBPOOL_TOKEN
- Optional Parameter
- A token that identifies the subpool that contains the element to release.
- FREE_LENGTH
- Optional Parameter
- The length of the element to release.
- LOCK_POOL
- Optional Parameter
- Indicates whether access to the subpool is controlled by a lock.
- Values for the parameter are as follows:
- NO
- YES
- REMARK
- Optional Parameter
- An optional 8-character field that identifies the FREEMAIN operation for problem determination. This field is highlighted when the FREEMAIN trace is interpreted. Typically, it is the name of the control block whose storage is being released.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- DEACTIVATE_FAILURE
- LOOP
- The following values are returned when RESPONSE is INVALID:
- INVALID_ADDRESS
- INVALID_FREE_LENGTH
- INVALID_STORAGE_CLASS
- INVALID_SUBPOOL_TOKEN
- NO_FREE_LENGTH
- NOT_SUBPOOL_OWNER
- SUBPOOL_EMPTY
- SUBPOOL_LOCK_FAILED
- SUBPOOL_UNLOCK_FAILED
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.