S2GF gate, INQUIRE_ELEMENT_LENGTH function
The INQUIRE_ELEMENT_LENGTH function of the S2GF gate is used to return the length of an element of storage whose address is known. This function is for use with subpools that have element chaining.
Input Parameters
- ADDRESS
- The 64-bit address of the element under inquiry.
- SUBPOOL_TOKEN
- Optional Parameter
- A token that identifies the subpool within which the element is allocated.
- LOCK_POOL
- Optional Parameter
- Indicates whether access to the subpool is controlled by a lock.
- Values for the parameter are as follows:
- NO
- YES
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- LOOP
- The following values are returned when RESPONSE is EXCEPTION:
- ADDRESS_NOT_FOUND
- The following values are returned when RESPONSE is INVALID:
- INVALID_STORAGE_CLASS
- INVALID_SUBPOOL_TOKEN
- SUBPOOL_LOCK_FAILED
- SUBPOOL_UNLOCK_FAILED
- ELEMENT_LENGTH
- The length of the element.
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.