void* pblPriorityQueueGetFirst

( PblPriorityQueue* queue,
  int* priority )

Returns but does not remove the element with the highest priority in the priority queue.

Documentation

Returns but does not remove the element with the highest priority in the priority queue.

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

Parameters:

queue - The queue to use
priority - On return contains the priority of the first element

Returns:

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

Alphabetic index