void* pblHeapGetFirst

( PblHeap* heap )

Returns but does not remove the element at the top of the heap.

Documentation

Returns but does not remove the element at the top of the heap.

This function has a time complexity of O(1).

Parameters:

heap - The heap to use

Returns:

void* retptr != (void*)-1: The element returned.
void* retptr == (void*)-1: An error see pbl_errno:
PBL_ERROR_OUT_OF_BOUNDS - The heap is empty.

Alphabetic index