void* pblListPoll

( PblList* list )

Retrieves and removes the head (first element) of this list.

Documentation

Retrieves and removes the head (first element) of this list.

For array lists this method has a time complexity of O(N), with N being the size of the list.

For linked lists this method has a time complexity of O(1).

Parameters:

list - The list to use

Returns:

void * retptr != (void*)-1: The head of this list, may be NULL.
void * retptr == (void*)-1: An error, see pbl_errno:
PBL_ERROR_OUT_OF_BOUNDS - this list is empty.

Alphabetic index