SMGF gate, FREEMAIN function

The FREEMAIN function of the SMGF gate is used to release an element of storage within a subpool.

Input Parameters

ADDRESS | ADDRESS_64
ADDRESS
The 31-bit address of the element to be released.
ADDRESS_64
The 64-bit address of the element to be released.
STORAGE_CLASS
Optional Parameter
Identifies the class of storage that is being released.
The parameter can take the following values:
  • CICS
  • CICS24
  • TASK
  • TASK24
  • TASK31
  • USER
  • USER24
SUBPOOL_TOKEN
Optional Parameter
A token that identifies the subpool within which the element is to be allocated.
FREE_LENGTH
Optional Parameter
The length of the element to be released.
LOCK_POOL
Optional Parameter
Indicates whether access to the subpool is controlled by a lock.
The parameter can take the following values:
  • NO
  • YES
REMARK
Optional Parameter
An optional 8-character field that is used to identify 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 obtained.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • DEACTIVATE_FAILURE
  • LOCK_ERROR
  • LOOP
  • UNLOCK_ERROR
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.


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