Mark Heap (CEEMKHP) API

Required Parameter Group:

1	heap_id	Input	INT4
2	mark	Output	POINTER

Omissible Parameter:

Output

FEEDBACK

  Service Program Name: QLEAWI

  Default Public Authority: *USE

  Threadsafe:

The Mark Heap (CEEMKHP) API returns a token, which can be used with the Release Heap (CEERLHP) API to free a heap storage group. After a CEEMKHP call, all storage subsequently obtained by the CEEGTST API can be freed by a single CEERLHP call. A heap may have multiple marks.

Authorities and Locks

None.

Required Parameter Group

heap_id (input): A heap identifier token specifying the heap to be marked.
mark (output): The mark token for use in a subsequent CEERLHP call.

Omissible Parameter

fc (output): A 12-byte feedback code.

Feedback Codes and Conditions

CEE0000	The API completed successfully
Severity: 00
CEE0803	The heap identifier does not match any existing heap
Severity: 30
CEE0812	The basic initial heap cannot be marked and discarded
Severity: 30

Usage Notes

The default heap in the activation group cannot be marked.
Multiple marks are maintained for each heap.

When a release operation is performed, the specified mark and all subsequent marks are removed from the list of active marks.
A mark should only be used in release operations. It should not be used as a pointer.

API introduced: V2R3

[ Back to top | ILE CEE APIs | APIs by category ]