Get Heap Storage (CEEGTST) API

Required Parameter Group:

Omissible Parameter:

Output

FEEDBACK

  Service Program Name: QLEAWI

  Default Public Authority: *USE

  Threadsafe: Yes

The Get Heap Storage (CEEGTST) API allocates storage within a heap.

None.

heap_id (input): A heap identifier of the heap in which the storage is allocated.
size (input): The number of bytes of storage to be allocated.
address (output): The address of the first byte of allocated storage.

CEE0000	The API completed successfully
Severity: 00
CEE0802	The storage headers are damaged
Severity: 40
CEE0803	The heap identifier does not match any existing heap
Severity: 30
CEE0808	Requested storage size is not valid
Severity: 30
CEE0813	Insufficient storage available to satisfy the request
Severity: 30

The size value is rounded up to a multiple of the minimum boundary specified when the heap space is created. The minimum boundary for the activation group default heap is 16 bytes.
The address of the first byte of the allocation begins on a boundary at least as great as the minimum boundary specified when the heap is created. The minimum boundary for the activation group default heap is 16 bytes.
A heap_id of 0 specifies the default heap in the activation group.
Individual allocations within a heap may not be contiguous.
Each allocation associated with a heap provides a sequence of contiguously addressable bytes. The bytes do not cross a 64KB boundary unless the allocation size is greater than 64KB.

API introduced: V2R3