SMMC gate, GETMAIN function

The GETMAIN function of the SMMC gate is used to allocate an element of storage.

Input Parameters

GET_LENGTH
The length of the storage requested.
STORAGE_CLASS
Identifies the class of storage that is being allocated.
Values for the parameter are as follows:
  • CICS
  • CICS24
  • CICS24_SAA
  • CONTROL
  • LINE
  • SHARED_CICS
  • SHARED_CICS24
  • SHARED_CICS24_SAA
  • SHARED_USER
  • SHARED_USER24
  • TACLE
  • TASK
  • TASK24
  • TASK31
  • TEMPSTG
  • TERMINAL
  • TERMINAL24
  • TRANSDATA
  • USER
  • USER24
SUSPEND
If there is insufficient storage to satisfy the request, SUSPEND(YES) suspends the caller until the request can be satisfied, and SUSPEND(NO) sets REASON to INSUFFICIENT_STORAGE.
Values for the parameter are as follows:
  • NO
  • YES
CALLER
Optional Parameter
Indicates the caller of the function.
Values for the parameter are as follows:
  • EXEC
  • MACRO
  • SYSTEM
INITIAL_IMAGE
Optional Parameter
An optional byte value to which every byte in the new element is set.
REMARK
Optional Parameter
An optional 8-character field that identifies the GETMAIN operation for problem determination. This field is highlighted when the GETMAIN trace is interpreted. Typically, it is the name of the control block whose storage is being obtained.
TCTTE_ADDRESS
Optional Parameter
An optional field that must be specified for GETMAIN requests for the TERMINAL storage class.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ACTIVATE_FAILURE
The following values are returned when RESPONSE is EXCEPTION:
  • INSUFFICIENT_STORAGE
  • INVALID_GET_LENGTH
The following values are returned when RESPONSE is INVALID:
  • INVALID_STORAGE_CLASS
  • INVALID_CLASS_ADDRESS
  • NO_TCTTE_ADDRESS
ADDRESS | ADDRESS_64
ADDRESS
The address of the new element if it is in 24-bit or 31-bit storage.
ADDRESS_64
The address of the new element if it is in 64-bit storage.
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


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