Release Heap (CEERLHP) API

Required Parameter:

mark

Input

POINTER

Omissible Parameter:

Output

FEEDBACK

  Service Program Name: QLEAWI

  Default Public Authority: *USE

  Threadsafe: Yes

The Release Heap (CEERLHP) API frees all storage allocated since the specified mark in the heap.

Authorities and Locks

None.

mark (input): A mark returned by a previous CEEMKHP call. All storage allocated in the marked heap since the corresponding mark operation is released. Marks obtained after the specified mark are also discarded.

CEE0000	The API completed successfully
Severity: 00
CEE0807	The mark does not match any existing mark
Severity: 30

No heap identifier is required for this call. The heap identifier of the heap to be released is inferred from the mark address. The release operation may be issued from an activation group other than the activation group that owns the heap.
Multiple marks can be maintained for each heap. A release operation deallocates all storage allocated since the specified mark operation.

Mark and release operations treat the heap in a fashion similar to a stack. There must be a mark operation outstanding at the location used in a release operation. A release operation can reset the heap to any mark; a release operation can clear one or several mark operations.
Pointers obtained by CEEGTST for storage that is freed by the release operation are no longer valid after this call. Continued use of these pointers will give unpredictable or incorrect results.

API introduced: V2R3